Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

BatchChainPainter

Minimal painter surface for batch / chain helpers.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/batch.ts (opens in a new tab)

Signature

TypeScript
export interface BatchChainPainter {
    createCanvas(config: CanvasConfig, painterOpts?: PainterAssetRefsOptions): Promise<{
        buffer: Buffer;
    }>;
    createImage(images: ImageProperties | ImageProperties[], canvasBuffer: unknown, options?: unknown, painterOpts?: PainterAssetRefsOptions): Promise<Buffer>;
    createText(textArray: TextProperties | TextProperties[], canvasBuffer: unknown, painterOpts?: PainterAssetRefsOptions): Promise<Buffer>;
}

Related APIs

No explicit related API metadata.

Next steps

AdsrEnvelopeAPI · node · CURRENT

ADSR envelope (seconds + sustain level 0–1). Stages are proportionally fitted when A+D+R exceeds the layer duration.

ApexifyPluginAPI · node · CURRENT

Install hook for optional features without growing the core {@link ApexPainter } class. Installation may be synchronous or asynchronous. `ApexPainter.use(plugin)` always returns a Promise and must be awaited before plugin APIs are considered installed. Plugin names are unique per painter. Registrations made through `painter.plugins` during a failed installation are rolled back.

AssetRegistrationInfoAPI · node · CURRENT

Published interface export AssetRegistrationInfo.

AvatarToLayersOptionsAPI · node · CURRENT

Published interface export AvatarToLayersOptions.