@dusrel/image API
    Preparing search index...

    Interface CodecPluginDefinition<Options>

    A codec registration: a WASM codec package's encode function plus the MIME type it produces (docs/API_DESIGN.md section 6, stabilised in ADR-0007). Register via ImageOptions.codecs and select with format, or turn one into a pipeline step with codecPlugin.

    interface CodecPluginDefinition<Options = unknown> {
        encode: (
            data: ImageData,
            options?: Options,
        ) =>
            | ArrayBuffer
            | Uint8Array<ArrayBufferLike>
            | Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>;
        mimeType: string;
        name?: string;
        options?: Options;
    }

    Type Parameters

    • Options = unknown
    Index
    encode: (
        data: ImageData,
        options?: Options,
    ) =>
        | ArrayBuffer
        | Uint8Array<ArrayBufferLike>
        | Promise<ArrayBuffer | Uint8Array<ArrayBufferLike>>

    The codec package's encode function (ImageData -> encoded bytes).

    mimeType: string

    Output MIME type, e.g. 'image/avif'.

    name?: string

    Step name for the report. Default: derived from mimeType ('image/avif' -> 'codec:avif').

    options?: Options

    Options forwarded verbatim to the codec's encode.