Type

OutputOptions

The options for creating an Output object.

type OutputOptions<F extends OutputFormat = OutputFormat, T extends Target = Target> = {
	format: F;
	target: T | PathedTarget<T>;
	initTarget?: T | (() => MaybePromise<T>);
	onFinalize?: () => MaybePromise<unknown>;
};

See PathedTarget, MaybePromise, OutputFormat, and Target.

Used by

• new Output()

Properties

format

format: F;

The format of the output file.

target

target: T | PathedTarget<T>;

The target to which the file will be written.

See PathedTarget.

initTarget

initTarget?: T | (() => MaybePromise<T>);

Optional; the target to which the track initialization data will be written. Most formats do not make use of this, but some do, such as CmafOutputFormat.

When this is a function, it will only be called if an init target is needed.

See MaybePromise.

Events

onFinalize

onFinalize?: (() => unknown);

Optional; a callback to be called at the end of Output.finalize. Can be used to run logic once the output has completed. If a promise is returned, it will be awaited internally by Output.finalize.