Class

RangedTarget

A target that writes to a subrange (defined by an offset) of another, underlying target. Useful for writing a file into a section of a larger file.

Extends: Target

Used by

• AppendOnlyStreamTarget.slice()
• BufferTarget.slice()
• FilePathTarget.slice()
• NullTarget.slice()
• StreamTarget.slice()
• Target.slice()

Events

onwrite

onwrite: ((start: number, end: number) => unknown) | null;

Called each time data is written to the target. Will be called with the byte range into which data was written.

Use this callback to track the size of the output file as it grows. But be warned, this function is chatty and gets called extremely often.

Methods

slice()

slice(
	offset: number,
): RangedTarget;

Returns a new RangedTarget that writes data to this target using the given offset.

Useful for writing a file into a section of a larger file.