Skip to content
1 min read · 205 words

Interface: ImageNamespace ​

Defined in: src/batteries/media/builder.ts:402

image.* verbs (the runtime fuses adjacent image steps into one engine pass).

Methods ​

annotate() ​

ts
annotate(shapes: ImageAnnotation[]): MediaChain;

Defined in: src/batteries/media/builder.ts:434

Draw vector primitives and text over the image.

Parameters ​

ParameterType
shapesImageAnnotation[]

Returns ​

MediaChain


flip() ​

ts
flip(axis: "both" | "horizontal" | "vertical"): MediaChain;

Defined in: src/batteries/media/builder.ts:426

Flip.

Parameters ​

ParameterType
axis"both" | "horizontal" | "vertical"

Returns ​

MediaChain


format() ​

ts
format(to: string, options?: {
  quality?: number;
  stripMetadata?: boolean;
}): MediaChain;

Defined in: src/batteries/media/builder.ts:415

Re-encode to another format.

Parameters ​

ParameterType
tostring
options{ quality?: number; stripMetadata?: boolean; }
options.quality?number
options.stripMetadata?boolean

Returns ​

MediaChain


resize() ​

ts
resize(options: ResizeOptions): MediaChain;

Defined in: src/batteries/media/builder.ts:408

Resize.

Parameters ​

ParameterType
optionsResizeOptions

Returns ​

MediaChain


rotate() ​

ts
rotate(deg: 90 | 180 | 270): MediaChain;

Defined in: src/batteries/media/builder.ts:422

Rotate clockwise.

Parameters ​

ParameterType
deg90 | 180 | 270

Returns ​

MediaChain


stripMetadata() ​

ts
stripMetadata(): MediaChain;

Defined in: src/batteries/media/builder.ts:430

Strip EXIF/ICC metadata.

Returns ​

MediaChain