Interface ImageTransformer

interface ImageTransformer {
    draw(
        image: ReadableStream<Uint8Array<ArrayBufferLike>> | ImageTransformer,
        options?: ImageDrawOptions,
    ): ImageTransformer;
    output(options: ImageOutputOptions): Promise<ImageTransformationResult>;
    transform(transform: ImageTransform): ImageTransformer;
}

Index

Methods

draw output transform

Methods

draw

draw(
image: ReadableStream<Uint8Array<ArrayBufferLike>> | ImageTransformer,
options?: ImageDrawOptions,
): ImageTransformer
Draw an image on this transformer, returning a transform handle. You can then apply more transformations, draw, or retrieve the output.
Parameters
- image: ReadableStream<Uint8Array<ArrayBufferLike>> | ImageTransformer
  The image (or transformer that will give the image) to draw
- Optionaloptions: ImageDrawOptions
  The options configuring how to draw the image
Returns ImageTransformer
- Defined in src/server/worker-configuration.d.ts:13912

output

output(options: ImageOutputOptions): Promise<ImageTransformationResult>
Retrieve the image that results from applying the transforms to the provided input
Parameters
- options: ImageOutputOptions
  Options that apply to the output e.g. output format
Returns Promise<ImageTransformationResult>
- Defined in src/server/worker-configuration.d.ts:13918

transform

transform(transform: ImageTransform): ImageTransformer
Apply transform next, returning a transform handle. You can then apply more transformations, draw, or retrieve the output.
Parameters
- transform: ImageTransform
Returns ImageTransformer
- Defined in src/server/worker-configuration.d.ts:13905