interface export
PainterImageUtils
Grouped image / stitch / palette API: `await painter.image.stitchImages(…)`, `.resize`, …
apexify.jsCURRENTnode22node24node26
Source: lib-next/types/painter-image.ts (opens in a new tab)Signature
export interface PainterImageUtils {
stitchImages(images: Array<string | Buffer>, options?: StitchOptions): Promise<Buffer>;
createCollage(images: Array<{
source: string | Buffer;
width?: number;
height?: number;
}>, layout: CollageLayout): Promise<Buffer>;
compress(image: string | Buffer, options?: CompressionOptions): Promise<Buffer>;
extractPalette(image: string | Buffer, options?: PaletteOptions): Promise<Array<{
color: string;
percentage: number;
}>>;
resize(resizeOptions: ResizeOptions): Promise<Buffer>;
imgConverter(source: string | Buffer, newExtension: string): Promise<Buffer>;
effects(source: string | Buffer, filters: ImageFilter[]): Promise<Buffer>;
colorsFilter(source: string | Buffer, filterColor: string | GradientConfig, opacity?: number): Promise<Buffer>;
colorAnalysis(source: string | Buffer): Promise<{
color: string;
frequency: string;
}[]>;
/** Operational failures throw structured Apexify errors; successful calls always return bytes. */
colorsRemover(source: string | Buffer, colorToRemove: {
red: number;
green: number;
blue: number;
}): Promise<Buffer>;
/** Credentials are caller supplied; failures throw `ApexifyExternalServiceError`. */
removeBackground(imageURL: string, apiKey: string): Promise<Buffer>;
blend(layers: ImageBlendLayer[], baseImageBuffer: Buffer, defaultBlendMode?: GlobalCompositeOperation): Promise<Buffer>;
cropImage(options: cropOptions): Promise<Buffer>;
masking(source: string | Buffer | PathLike | Uint8Array, maskSource: string | Buffer | PathLike | Uint8Array, options?: MaskOptions): Promise<Buffer>;
gradientBlend(source: string | Buffer | PathLike | Uint8Array, options: BlendOptions): Promise<Buffer>;
validHex(hexColor: string): boolean;
}Related APIs
No explicit related API metadata.