Interface RunOptions

Options for Pipeline.run and createPreviewRunner.

interface RunOptions {
    output?: OutputKind;
    type?: string;
    quality?: number;
    worker?: boolean;
    signal?: AbortSignal;
    colorMode?: ColorMode;
}

Hierarchy (View Summary)

ColorOptions
- RunOptions

Index

Properties

output? type? quality? worker? signal? colorMode?

Properties

`Optional`output

output?: OutputKind

Result type. Default imageData.

`Optional`type

type?: string

Encoding for output: 'blob'. Default image/png.

`Optional`quality

quality?: number

Encoder quality 0-1 for lossy types.

`Optional`worker

worker?: boolean

Run in Web Workers (default true). Falls back to the main thread automatically.

`Optional`signal

signal?: AbortSignal

Cancels the run; the promise rejects with an AbortError.

`Optional`colorMode

colorMode?: ColorMode

Default auto.