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

ApexPainter member

ApexPainter.batch

Published ApexPainter.batch method.

apexify.jsCURRENTnode22node24node26
Source: lib-next/apex-painter/main.ts (opens in a new tab)

Signature

TypeScript
(operations: BatchOperation[], opts?: BatchChainAssetOpts) => Promise<Buffer[]>

Parameters

operations

BatchOperation[]

Options

213 / 213 option paths
OptionTypeContractAllowed valuesRuntime & capabilities
operations
operations.configPublished operations.config option.CanvasConfigRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayersPublished operations.config.bgLayers option.BackgroundLayer[]OptionalDefault——node22 · node24 · node26
operations.config.bgLayers.blendModePublished operations.config.bgLayers.blendMode option.GlobalCompositeOperationOptionalDefault—
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
node22 · node24 · node26
operations.config.bgLayers.opacityPublished operations.config.bgLayers.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.typePublished operations.config.bgLayers.type option."color"RequiredDefaultRequired"color"node22 · node24 · node26
operations.config.bgLayers.valuePublished operations.config.bgLayers.value option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.alignPublished operations.config.bgLayers.align option.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
operations.config.bgLayers.fitPublished operations.config.bgLayers.fit option."fill" | "contain" | "cover"OptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
operations.config.bgLayers.sourcePublished operations.config.bgLayers.source option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.repeatPublished operations.config.bgLayers.repeat option.BackgroundPatternRepeatOptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
operations.config.bgLayers.patternPublished operations.config.bgLayers.pattern option.PatternOptionsRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.pattern.blendModePublished operations.config.bgLayers.pattern.blendMode option.GlobalCompositeOperationOptionalDefault—
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
node22 · node24 · node26
operations.config.bgLayers.pattern.colorPublished operations.config.bgLayers.pattern.color option.stringOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.customPatternImagePublished operations.config.bgLayers.pattern.customPatternImage option.stringOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradientPublished operations.config.bgLayers.pattern.gradient option.GradientConfigOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.anglePublished operations.config.bgLayers.pattern.gradient.angle option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.centerXPublished operations.config.bgLayers.pattern.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.centerYPublished operations.config.bgLayers.pattern.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.colorsPublished operations.config.bgLayers.pattern.gradient.colors option.{ stop: number; color: string; }[]RequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.colors.colorPublished operations.config.bgLayers.pattern.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.colors.stopPublished operations.config.bgLayers.pattern.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.endRadiusPublished operations.config.bgLayers.pattern.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.endXPublished operations.config.bgLayers.pattern.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.endYPublished operations.config.bgLayers.pattern.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.repeatPublished operations.config.bgLayers.pattern.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.startAnglePublished operations.config.bgLayers.pattern.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.startRadiusPublished operations.config.bgLayers.pattern.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.startXPublished operations.config.bgLayers.pattern.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.startYPublished operations.config.bgLayers.pattern.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.gradient.typePublished operations.config.bgLayers.pattern.gradient.type option."linear" | "radial" | "conic"RequiredDefaultRequired"linear" "radial" "conic"node22 · node24 · node26
operations.config.bgLayers.pattern.offsetXPublished operations.config.bgLayers.pattern.offsetX option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.offsetYPublished operations.config.bgLayers.pattern.offsetY option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.opacityPublished operations.config.bgLayers.pattern.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.repeatPublished operations.config.bgLayers.pattern.repeat option."repeat" | "no-repeat" | "repeat-x" | "repeat-y"OptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
operations.config.bgLayers.pattern.rotationPublished operations.config.bgLayers.pattern.rotation option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.scalePublished operations.config.bgLayers.pattern.scale option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.secondaryColorPublished operations.config.bgLayers.pattern.secondaryColor option.stringOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.sizePublished operations.config.bgLayers.pattern.size option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.spacingPublished operations.config.bgLayers.pattern.spacing option.numberOptionalDefault——node22 · node24 · node26
operations.config.bgLayers.pattern.typePublished operations.config.bgLayers.pattern.type option."grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"RequiredDefaultRequired
13 values
"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom"
node22 · node24 · node26
operations.config.bgLayers.intensityPublished operations.config.bgLayers.intensity option.numberOptionalDefault——node22 · node24 · node26
operations.config.blendModePublished operations.config.blendMode option.GlobalCompositeOperationOptionalDefault—
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
node22 · node24 · node26
operations.config.blurPublished operations.config.blur option.numberOptionalDefault——node22 · node24 · node26
operations.config.borderPositionPublished operations.config.borderPosition option.stringOptionalDefault——node22 · node24 · node26
operations.config.borderRadiusPublished operations.config.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
operations.config.colorBgPublished operations.config.colorBg option.stringOptionalDefault——node22 · node24 · node26
operations.config.customBgPublished operations.config.customBg option.CanvasCustomBackgroundOptionalDefault——node22 · node24 · node26
operations.config.customBg.alignPlacement used by `contain` / `cover` when `inherit` is false.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
operations.config.customBg.filtersImage filters applied to this background only.ImageFilter[]OptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.anglePublished operations.config.customBg.filters.angle option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.centerXPublished operations.config.customBg.filters.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.centerYPublished operations.config.customBg.filters.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.heightPublished operations.config.customBg.filters.height option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.intensityPublished operations.config.customBg.filters.intensity option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.levelsPublished operations.config.customBg.filters.levels option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.radiusPublished operations.config.customBg.filters.radius option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.sizePublished operations.config.customBg.filters.size option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.typePublished operations.config.customBg.filters.type option."saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"RequiredDefaultRequired
17 values
"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize"
node22 · node24 · node26
operations.config.customBg.filters.valuePublished operations.config.customBg.filters.value option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.widthPublished operations.config.customBg.filters.width option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.xOptional pixelate region. Omit for the whole filtered surface.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.filters.yPublished operations.config.customBg.filters.y option.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.fitResize policy when `inherit` is false.FitModeOptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
operations.config.customBg.inheritAdopt the source image dimensions as the canvas dimensions.booleanOptionalDefault—false truenode22 · node24 · node26
operations.config.customBg.opacityBackground-image opacity, multiplied by the canvas-level opacity.numberOptionalDefault——node22 · node24 · node26
operations.config.customBg.sourcePublished operations.config.customBg.source option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.gradientBgPublished operations.config.gradientBg option.gradientOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.colorsPublished operations.config.gradientBg.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
operations.config.gradientBg.colors.colorPublished operations.config.gradientBg.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.gradientBg.colors.stopPublished operations.config.gradientBg.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
operations.config.gradientBg.endXPublished operations.config.gradientBg.endX option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.endYPublished operations.config.gradientBg.endY option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.pivotXPublished operations.config.gradientBg.pivotX option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.pivotYPublished operations.config.gradientBg.pivotY option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.repeatPublished operations.config.gradientBg.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
operations.config.gradientBg.rotatePublished operations.config.gradientBg.rotate option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.startXPublished operations.config.gradientBg.startX option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.startYPublished operations.config.gradientBg.startY option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.typePublished operations.config.gradientBg.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
operations.config.gradientBg.endRadiusPublished operations.config.gradientBg.endRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.startRadiusPublished operations.config.gradientBg.startRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.centerXPublished operations.config.gradientBg.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.centerYPublished operations.config.gradientBg.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.gradientBg.startAnglePublished operations.config.gradientBg.startAngle option.numberOptionalDefault——node22 · node24 · node26
operations.config.heightPublished operations.config.height option.numberOptionalDefault——node22 · node24 · node26
operations.config.noiseBgPublished operations.config.noiseBg option.{ intensity?: number; }OptionalDefault——node22 · node24 · node26
operations.config.noiseBg.intensityPublished operations.config.noiseBg.intensity option.numberOptionalDefault——node22 · node24 · node26
operations.config.opacityPublished operations.config.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBgPublished operations.config.patternBg option.PatternOptionsOptionalDefault——node22 · node24 · node26
operations.config.patternBg.blendModePublished operations.config.patternBg.blendMode option.GlobalCompositeOperationOptionalDefault—
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
node22 · node24 · node26
operations.config.patternBg.colorPublished operations.config.patternBg.color option.stringOptionalDefault——node22 · node24 · node26
operations.config.patternBg.customPatternImagePublished operations.config.patternBg.customPatternImage option.stringOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradientPublished operations.config.patternBg.gradient option.GradientConfigOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.anglePublished operations.config.patternBg.gradient.angle option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.centerXPublished operations.config.patternBg.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.centerYPublished operations.config.patternBg.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.colorsPublished operations.config.patternBg.gradient.colors option.{ stop: number; color: string; }[]RequiredDefaultRequired—node22 · node24 · node26
operations.config.patternBg.gradient.colors.colorPublished operations.config.patternBg.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.patternBg.gradient.colors.stopPublished operations.config.patternBg.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
operations.config.patternBg.gradient.endRadiusPublished operations.config.patternBg.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.endXPublished operations.config.patternBg.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.endYPublished operations.config.patternBg.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.repeatPublished operations.config.patternBg.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
operations.config.patternBg.gradient.startAnglePublished operations.config.patternBg.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.startRadiusPublished operations.config.patternBg.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.startXPublished operations.config.patternBg.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.startYPublished operations.config.patternBg.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.gradient.typePublished operations.config.patternBg.gradient.type option."linear" | "radial" | "conic"RequiredDefaultRequired"linear" "radial" "conic"node22 · node24 · node26
operations.config.patternBg.offsetXPublished operations.config.patternBg.offsetX option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.offsetYPublished operations.config.patternBg.offsetY option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.opacityPublished operations.config.patternBg.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.repeatPublished operations.config.patternBg.repeat option."repeat" | "no-repeat" | "repeat-x" | "repeat-y"OptionalDefault—"repeat" "no-repeat" "repeat-x" "repeat-y"node22 · node24 · node26
operations.config.patternBg.rotationPublished operations.config.patternBg.rotation option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.scalePublished operations.config.patternBg.scale option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.secondaryColorPublished operations.config.patternBg.secondaryColor option.stringOptionalDefault——node22 · node24 · node26
operations.config.patternBg.sizePublished operations.config.patternBg.size option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.spacingPublished operations.config.patternBg.spacing option.numberOptionalDefault——node22 · node24 · node26
operations.config.patternBg.typePublished operations.config.patternBg.type option."grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"RequiredDefaultRequired
13 values
"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom"
node22 · node24 · node26
operations.config.rotationPublished operations.config.rotation option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadowPublished operations.config.shadow option.ShadowOptionsOptionalDefault——node22 · node24 · node26
operations.config.shadow.blurPublished operations.config.shadow.blur option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.borderPositionPublished operations.config.shadow.borderPosition option.DeprecatedstringOptionalDefault——node22 · node24 · node26
operations.config.shadow.borderRadiusPublished operations.config.shadow.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
operations.config.shadow.colorPublished operations.config.shadow.color option.stringOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradientPublished operations.config.shadow.gradient option.gradientOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.colorsPublished operations.config.shadow.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
operations.config.shadow.gradient.colors.colorPublished operations.config.shadow.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.shadow.gradient.colors.stopPublished operations.config.shadow.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
operations.config.shadow.gradient.endXPublished operations.config.shadow.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.endYPublished operations.config.shadow.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.pivotXPublished operations.config.shadow.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.pivotYPublished operations.config.shadow.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.repeatPublished operations.config.shadow.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
operations.config.shadow.gradient.rotatePublished operations.config.shadow.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.startXPublished operations.config.shadow.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.startYPublished operations.config.shadow.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.typePublished operations.config.shadow.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
operations.config.shadow.gradient.endRadiusPublished operations.config.shadow.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.startRadiusPublished operations.config.shadow.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.centerXPublished operations.config.shadow.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.centerYPublished operations.config.shadow.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.gradient.startAnglePublished operations.config.shadow.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.offsetXPublished operations.config.shadow.offsetX option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.offsetYPublished operations.config.shadow.offsetY option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.opacityPublished operations.config.shadow.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.shadow.roundedCornersPublished operations.config.shadow.roundedCorners option.stringOptionalDefault——node22 · node24 · node26
operations.config.strokePublished operations.config.stroke option.StrokeOptionsOptionalDefault——node22 · node24 · node26
operations.config.stroke.blurPublished operations.config.stroke.blur option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.borderPositionPublished operations.config.stroke.borderPosition option.stringOptionalDefault——node22 · node24 · node26
operations.config.stroke.borderRadiusPublished operations.config.stroke.borderRadius option.number | "circular"OptionalDefault——node22 · node24 · node26
operations.config.stroke.colorPublished operations.config.stroke.color option.stringOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradientPublished operations.config.stroke.gradient option.gradientOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.colorsPublished operations.config.stroke.gradient.colors option.GradientStop[]RequiredDefaultRequired—node22 · node24 · node26
operations.config.stroke.gradient.colors.colorPublished operations.config.stroke.gradient.colors.color option.stringRequiredDefaultRequired—node22 · node24 · node26
operations.config.stroke.gradient.colors.stopPublished operations.config.stroke.gradient.colors.stop option.numberRequiredDefaultRequired—node22 · node24 · node26
operations.config.stroke.gradient.endXPublished operations.config.stroke.gradient.endX option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.endYPublished operations.config.stroke.gradient.endY option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.pivotXPublished operations.config.stroke.gradient.pivotX option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.pivotYPublished operations.config.stroke.gradient.pivotY option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.repeatPublished operations.config.stroke.gradient.repeat option."repeat" | "reflect" | "no-repeat"OptionalDefault—"repeat" "reflect" "no-repeat"node22 · node24 · node26
operations.config.stroke.gradient.rotatePublished operations.config.stroke.gradient.rotate option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.startXPublished operations.config.stroke.gradient.startX option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.startYPublished operations.config.stroke.gradient.startY option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.typePublished operations.config.stroke.gradient.type option."linear"RequiredDefaultRequired"linear"node22 · node24 · node26
operations.config.stroke.gradient.endRadiusPublished operations.config.stroke.gradient.endRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.startRadiusPublished operations.config.stroke.gradient.startRadius option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.centerXPublished operations.config.stroke.gradient.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.centerYPublished operations.config.stroke.gradient.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.gradient.startAnglePublished operations.config.stroke.gradient.startAngle option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.opacityPublished operations.config.stroke.opacity option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.positionPublished operations.config.stroke.position option.numberOptionalDefault——node22 · node24 · node26
operations.config.stroke.roundedCornersPublished operations.config.stroke.roundedCorners option.stringOptionalDefault——node22 · node24 · node26
operations.config.stroke.stylePublished operations.config.stroke.style option."solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"OptionalDefault—
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
node22 · node24 · node26
operations.config.stroke.widthPublished operations.config.stroke.width option.numberOptionalDefault——node22 · node24 · node26
operations.config.transparentBasePublished operations.config.transparentBase option.booleanOptionalDefault—false truenode22 · node24 · node26
operations.config.videoBgPublished operations.config.videoBg option.CanvasVideoBackgroundOptionalDefault——node22 · node24 · node26
operations.config.videoBg.alignPlacement used by `contain` / `cover` when `inherit` is false.AlignModeOptionalDefault—
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
node22 · node24 · node26
operations.config.videoBg.autoplayPublished operations.config.videoBg.autoplay option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
operations.config.videoBg.filtersImage filters applied to this background only.ImageFilter[]OptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.anglePublished operations.config.videoBg.filters.angle option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.centerXPublished operations.config.videoBg.filters.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.centerYPublished operations.config.videoBg.filters.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.heightPublished operations.config.videoBg.filters.height option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.intensityPublished operations.config.videoBg.filters.intensity option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.levelsPublished operations.config.videoBg.filters.levels option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.radiusPublished operations.config.videoBg.filters.radius option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.sizePublished operations.config.videoBg.filters.size option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.typePublished operations.config.videoBg.filters.type option."saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"RequiredDefaultRequired
17 values
"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize"
node22 · node24 · node26
operations.config.videoBg.filters.valuePublished operations.config.videoBg.filters.value option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.widthPublished operations.config.videoBg.filters.width option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.xOptional pixelate region. Omit for the whole filtered surface.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.filters.yPublished operations.config.videoBg.filters.y option.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.fitResize policy when `inherit` is false.FitModeOptionalDefault—"fill" "contain" "cover"node22 · node24 · node26
operations.config.videoBg.formatPublished operations.config.videoBg.format option."jpg" | "png"OptionalDefault—"jpg" "png"node22 · node24 · node26
operations.config.videoBg.frame1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.inheritAdopt the source image dimensions as the canvas dimensions.booleanOptionalDefault—false truenode22 · node24 · node26
operations.config.videoBg.loopPublished operations.config.videoBg.loop option.DeprecatedbooleanOptionalDefault—false truenode22 · node24 · node26
operations.config.videoBg.opacityBackground-image opacity, multiplied by the canvas-level opacity.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.qualityFFmpeg image quality value from 1 (best) through 31.numberOptionalDefault——node22 · node24 · node26
operations.config.videoBg.sourcePublished operations.config.videoBg.source option.string | Buffer<ArrayBufferLike>RequiredDefaultRequired—node22 · node24 · node26
operations.config.videoBg.timeTimestamp in seconds. Mutually exclusive with `frame`.numberOptionalDefault——node22 · node24 · node26
operations.config.widthPublished operations.config.width option.numberOptionalDefault——node22 · node24 · node26
operations.config.xPublished operations.config.x option.numberOptionalDefault——node22 · node24 · node26
operations.config.yPublished operations.config.y option.numberOptionalDefault——node22 · node24 · node26
operations.config.zoomPublished operations.config.zoom option.{ scale?: number; centerX?: number; centerY?: number; }OptionalDefault——node22 · node24 · node26
operations.config.zoom.centerXPublished operations.config.zoom.centerX option.numberOptionalDefault——node22 · node24 · node26
operations.config.zoom.centerYPublished operations.config.zoom.centerY option.numberOptionalDefault——node22 · node24 · node26
operations.config.zoom.scalePublished operations.config.zoom.scale option.numberOptionalDefault——node22 · node24 · node26
operations.typePublished operations.type option."canvas"RequiredDefaultRequired"canvas"node22 · node24 · node26
opts
opts.concurrencyPer-call concurrency, capped by runtime `limits.maxBatchConcurrency`.numberOptionalDefault——node22 · node24 · node26
opts.resolvePublished opts.resolve option.AssetResolveFnOptionalDefault——node22 · node24 · node26
opts.resolveAssetRefsPublished opts.resolveAssetRefs option.booleanOptionalDefault—false truenode22 · node24 · node26
opts.signalAbort stops scheduling new batch work and prevents later chain steps.AbortSignalOptionalDefault——node22 · node24 · node26

operations.config

Required

Published operations.config option.

Type
CanvasConfig
Default
Required
Allowed
—
Runtime
node22, node24, node26

operations.config.bgLayers

Optional

Published operations.config.bgLayers option.

Type
BackgroundLayer[]
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.bgLayers.blendMode

Optional

Published operations.config.bgLayers.blendMode option.

Type
GlobalCompositeOperation
Default
—
Allowed
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
Runtime
node22, node24, node26

operations.config.bgLayers.type

Required

Published operations.config.bgLayers.type option.

Type
"color"
Default
Required
Allowed
"color"
Runtime
node22, node24, node26

operations.config.bgLayers.align

Optional

Published operations.config.bgLayers.align option.

Type
AlignMode
Default
—
Allowed
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

operations.config.bgLayers.fit

Optional

Published operations.config.bgLayers.fit option.

Type
"fill" | "contain" | "cover"
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

operations.config.bgLayers.repeat

Optional

Published operations.config.bgLayers.repeat option.

Type
BackgroundPatternRepeat
Default
—
Allowed
"repeat" "no-repeat" "repeat-x" "repeat-y"
Runtime
node22, node24, node26

operations.config.bgLayers.pattern.blendMode

Optional

Published operations.config.bgLayers.pattern.blendMode option.

Type
GlobalCompositeOperation
Default
—
Allowed
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
Runtime
node22, node24, node26

operations.config.bgLayers.pattern.repeat

Optional

Published operations.config.bgLayers.pattern.repeat option.

Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"
Default
—
Allowed
"repeat" "no-repeat" "repeat-x" "repeat-y"
Runtime
node22, node24, node26

operations.config.bgLayers.pattern.type

Required

Published operations.config.bgLayers.pattern.type option.

Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"
Default
Required
Allowed
13 values
"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom"
Runtime
node22, node24, node26

operations.config.blendMode

Optional

Published operations.config.blendMode option.

Type
GlobalCompositeOperation
Default
—
Allowed
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
Runtime
node22, node24, node26

operations.config.blur

Optional

Published operations.config.blur option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.borderRadius

Optional

Published operations.config.borderRadius option.

Type
number | "circular"
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.colorBg

Optional

Published operations.config.colorBg option.

Type
string
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.customBg

Optional

Published operations.config.customBg option.

Type
CanvasCustomBackground
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.customBg.align

Optional

Placement used by `contain` / `cover` when `inherit` is false.

Type
AlignMode
Default
—
Allowed
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

operations.config.customBg.filters.type

Required

Published operations.config.customBg.filters.type option.

Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"
Default
Required
Allowed
17 values
"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize"
Runtime
node22, node24, node26

operations.config.customBg.fit

Optional

Resize policy when `inherit` is false.

Type
FitMode
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

operations.config.gradientBg

Optional

Published operations.config.gradientBg option.

Type
gradient
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.gradientBg.repeat

Optional

Published operations.config.gradientBg.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

operations.config.height

Optional

Published operations.config.height option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.noiseBg

Optional

Published operations.config.noiseBg option.

Type
{ intensity?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.opacity

Optional

Published operations.config.opacity option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.patternBg

Optional

Published operations.config.patternBg option.

Type
PatternOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.patternBg.blendMode

Optional

Published operations.config.patternBg.blendMode option.

Type
GlobalCompositeOperation
Default
—
Allowed
26 values
"color" "color-burn" "color-dodge" "copy" "darken" "destination-atop" "destination-in" "destination-out" "destination-over" "difference" "exclusion" "hard-light" "hue" "lighten" "lighter" "luminosity" "multiply" "overlay" "saturation" "screen" "soft-light" "source-atop" "source-in" "source-out" "source-over" "xor"
Runtime
node22, node24, node26

operations.config.patternBg.gradient.repeat

Optional

Published operations.config.patternBg.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

operations.config.patternBg.gradient.type

Required

Published operations.config.patternBg.gradient.type option.

Type
"linear" | "radial" | "conic"
Default
Required
Allowed
"linear" "radial" "conic"
Runtime
node22, node24, node26

operations.config.patternBg.repeat

Optional

Published operations.config.patternBg.repeat option.

Type
"repeat" | "no-repeat" | "repeat-x" | "repeat-y"
Default
—
Allowed
"repeat" "no-repeat" "repeat-x" "repeat-y"
Runtime
node22, node24, node26

operations.config.patternBg.type

Required

Published operations.config.patternBg.type option.

Type
"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"
Default
Required
Allowed
13 values
"grid" "dots" "diagonal" "stripes" "waves" "crosses" "hexagons" "checkerboard" "diamonds" "triangles" "stars" "polka" "custom"
Runtime
node22, node24, node26

operations.config.rotation

Optional

Published operations.config.rotation option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.shadow

Optional

Published operations.config.shadow option.

Type
ShadowOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.shadow.gradient.repeat

Optional

Published operations.config.shadow.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

operations.config.stroke

Optional

Published operations.config.stroke option.

Type
StrokeOptions
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.stroke.gradient.repeat

Optional

Published operations.config.stroke.gradient.repeat option.

Type
"repeat" | "reflect" | "no-repeat"
Default
—
Allowed
"repeat" "reflect" "no-repeat"
Runtime
node22, node24, node26

operations.config.stroke.style

Optional

Published operations.config.stroke.style option.

Type
"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"
Default
—
Allowed
6 values
"solid" "dashed" "dotted" "groove" "ridge" "double"
Runtime
node22, node24, node26

operations.config.videoBg

Optional

Published operations.config.videoBg option.

Type
CanvasVideoBackground
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.videoBg.align

Optional

Placement used by `contain` / `cover` when `inherit` is false.

Type
AlignMode
Default
—
Allowed
9 values
"center" "top" "bottom" "left" "right" "top-left" "top-right" "bottom-left" "bottom-right"
Runtime
node22, node24, node26

operations.config.videoBg.filters.type

Required

Published operations.config.videoBg.filters.type option.

Type
"saturation" | "gaussianBlur" | "motionBlur" | "radialBlur" | "sharpen" | "noise" | "grain" | "edgeDetection" | "emboss" | "invert" | "grayscale" | "sepia" | "pixelate" | "brightness" | "contrast" | "hueShift" | "posterize"
Default
Required
Allowed
17 values
"saturation" "gaussianBlur" "motionBlur" "radialBlur" "sharpen" "noise" "grain" "edgeDetection" "emboss" "invert" "grayscale" "sepia" "pixelate" "brightness" "contrast" "hueShift" "posterize"
Runtime
node22, node24, node26

operations.config.videoBg.fit

Optional

Resize policy when `inherit` is false.

Type
FitMode
Default
—
Allowed
"fill" "contain" "cover"
Runtime
node22, node24, node26

operations.config.videoBg.format

Optional

Published operations.config.videoBg.format option.

Type
"jpg" | "png"
Default
—
Allowed
"jpg" "png"
Runtime
node22, node24, node26

operations.config.videoBg.frame

Optional

1-based frame number. Mutually exclusive with `time`. Defaults to frame 1 when neither selector is provided.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.videoBg.inherit

Optional

Adopt the source image dimensions as the canvas dimensions.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

operations.config.videoBg.loop

Optional

Published operations.config.videoBg.loop option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

operations.config.videoBg.opacity

Optional

Background-image opacity, multiplied by the canvas-level opacity.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.videoBg.source

Required

Published operations.config.videoBg.source option.

Type
string | Buffer<ArrayBufferLike>
Default
Required
Allowed
—
Runtime
node22, node24, node26

operations.config.videoBg.time

Optional

Timestamp in seconds. Mutually exclusive with `frame`.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.width

Optional

Published operations.config.width option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.x

Optional

Published operations.config.x option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.y

Optional

Published operations.config.y option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.zoom

Optional

Published operations.config.zoom option.

Type
{ scale?: number; centerX?: number; centerY?: number; }
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.config.zoom.scale

Optional

Published operations.config.zoom.scale option.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

operations.type

Required

Published operations.type option.

Type
"canvas"
Default
Required
Allowed
"canvas"
Runtime
node22, node24, node26

opts.concurrency

Optional

Per-call concurrency, capped by runtime `limits.maxBatchConcurrency`.

Type
number
Default
—
Allowed
—
Runtime
node22, node24, node26

opts.resolve

Optional

Published opts.resolve option.

Type
AssetResolveFn
Default
—
Allowed
—
Runtime
node22, node24, node26

opts.resolveAssetRefs

Optional

Published opts.resolveAssetRefs option.

Type
boolean
Default
—
Allowed
false true
Runtime
node22, node24, node26

opts.signal

Optional

Abort stops scheduling new batch work and prevents later chain steps.

Type
AbortSignal
Default
—
Allowed
—
Runtime
node22, node24, node26

Types

BatchOperation[]
  • variant 1
    BatchOperation
    • variant 1
      __type: { type: "canvas"; config: CanvasConfig; }
      • type"canvas"
      • config
        CanvasConfig: CanvasConfig
        • width?number
        • height?number
        • x?number
        • y?number
        • customBg?
          CanvasCustomBackground: CanvasCustomBackground
          • sourcestring
          • inherit?boolean
          • fit?FitMode
          • align?AlignMode
          • filters?ImageFilter[]
          • opacity?number
        • videoBg?
          CanvasVideoBackground: CanvasVideoBackground
          • sourcestring | Buffer<ArrayBufferLike>
          • frame?number
          • time?number
          • format?"jpg" | "png"
          • quality?number
          • loop?boolean
          • autoplay?boolean
          • inherit?boolean
          • fit?FitMode
          • align?AlignMode
          • filters?ImageFilter[]
          • opacity?number
        • colorBg?string
        • gradientBg?
          gradient
          • variant 1{ type: "linear"; startX?: number; startY?: number; endX?: number; endY?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
          • variant 2{ type: "radial"; startX?: number; startY?: number; startRadius?: number; endX?: number; endY?: number; endRadius?: number; rotate?: number; pivotX?: number; pivotY?: number; repeat?: "repeat" | "reflect" | "no-repeat"; colors: GradientStop[]; }
          • variant 3{ type: "conic"; centerX?: number; centerY?: number; startAngle?: number; rotate?: number; pivotX?: number; pivotY?: number; colors: GradientStop[]; }
        • patternBg?
          PatternOptions: PatternOptions
          • type"grid" | "dots" | "diagonal" | "stripes" | "waves" | "crosses" | "hexagons" | "checkerboard" | "diamonds" | "triangles" | "stars" | "polka" | "custom"
          • color?string
          • secondaryColor?string
          • opacity?number
          • size?number
          • spacing?number
          • rotation?number
          • customPatternImage?string
          • repeat?"repeat" | "no-repeat" | "repeat-x" | "repeat-y"
          • scale?number
          • offsetX?number
          • offsetY?number
          • blendMode?GlobalCompositeOperation
          • gradient?GradientConfig
        • noiseBg?
          __type: { intensity?: number; }
          • intensity?number
        • transparentBase?boolean
        • bgLayers?
          BackgroundLayer[]
          • variant 1BackgroundLayer
        • blendMode?
          GlobalCompositeOperation
          • variant 1"color"
          • variant 2"color-burn"
          • variant 3"color-dodge"
          • variant 4"copy"
          • variant 5"darken"
          • variant 6"destination-atop"
          • variant 7"destination-in"
          • variant 8"destination-out"
          • variant 9"destination-over"
          • variant 10"difference"
          • variant 11"exclusion"
          • variant 12"hard-light"
          • variant 13"hue"
          • variant 14"lighten"
          • variant 15"lighter"
          • variant 16"luminosity"
          • variant 17"multiply"
          • variant 18"overlay"
          • variant 19"saturation"
          • variant 20"screen"
          • variant 21"soft-light"
          • variant 22"source-atop"
          • variant 23"source-in"
          • variant 24"source-out"
          • variant 25"source-over"
          • variant 26"xor"
        • opacity?number
        • blur?number
        • rotation?number
        • borderRadius?
          number | "circular"
          • variant 1number
          • variant 2"circular"
        • borderPosition?string
        • zoom?
          __type: { scale?: number; centerX?: number; centerY?: number; }
          • scale?number
          • centerX?number
          • centerY?number
        • stroke?
          StrokeOptions: StrokeOptions
          • color?string
          • gradient?gradient
          • width?number
          • position?number
          • blur?number
          • opacity?number
          • borderRadius?number | "circular"
          • borderPosition?string
          • roundedCorners?string
          • style?"solid" | "dashed" | "dotted" | "groove" | "ridge" | "double"
        • shadow?
          ShadowOptions: ShadowOptions
          • color?string
          • gradient?gradient
          • offsetX?number
          • offsetY?number
          • blur?number
          • opacity?number
          • borderRadius?number | "circular"
          • roundedCorners?string
          • borderPosition?string
    • variant 2
      __type: { type: "image"; config: ImageProperties | ImageProperties[]; }
      • type"image"
      • config
        ImageProperties | ImageProperties[]
        • variant 1
          ImageProperties: ImageProperties
          • sourcestring | Buffer<ArrayBufferLike>
          • xnumber
          • ynumber
          • width?number
          • height?number
          • inherit?boolean
          • fit?FitMode
          • align?AlignMode
          • rotation?number
          • opacity?number
          • blur?number
          • blendMode?GlobalCompositeOperation
          • borderRadius?number | "circular"
          • borderPosition?string
          • filters?ImageFilter[]
          • filterIntensity?number
          • filterOrder?"pre" | "post"
          • mask?{ source: string | Buffer<ArrayBufferLike>; mode?: "alpha" | "luminance" | "inverse"; }
          • clipPath?{ x: number; y: number; }[]
          • distortion?{ type: "perspective" | "warp" | "bulge" | "pinch"; points?: { x: number; y: number; }[]; intensity?: number; }
          • meshWarp?{ gridX?: number; gridY?: number; controlPoints?: { x: number; y: number; }[][]; }
          • effects?{ vignette?: { intensity: number; size: number; }; lensFlare?: { x: number; y: number; intensity: number; }; chromaticAberration?: { intensity: number; }; filmGrain?: { intensity: number; }; }
          • shape?ShapeProperties
          • shadow?ShadowOptions
          • stroke?StrokeOptions
          • boxBackground?BoxBackground
        • variant 2
          ImageProperties[]
          • variant 1ImageProperties
    • variant 3
      __type: { type: "text"; config: TextProperties | TextProperties[]; }
      • type"text"
      • config
        TextProperties | TextProperties[]
        • variant 1
          TextProperties: TextProperties
          • textstring
          • xnumber
          • ynumber
          • font?{ size?: number; family?: string; name?: string; path?: string; }
          • fontSize?number
          • fontFamily?string
          • fontName?string
          • fontPath?string
          • bold?boolean
          • italic?boolean
          • decorations?TextDecorations
          • effects?TextEffects
          • underline?TextLineDecoration
          • overline?TextLineDecoration
          • strikethrough?TextLineDecoration
          • highlight?TextHighlightStyle
          • glow?TextGlowStyle
          • shadow?TextShadowStyle
          • layout?TextLayout
          • placement?TextPlacement
          • fill?TextFill
          • lineHeight?number
          • letterSpacing?number
          • wordSpacing?number
          • maxWidth?number
          • maxHeight?number
          • textAlign?TextAlignMode
          • textBaseline?TextBaselineMode
          • rotation?number
          • color?string
          • gradient?gradient
          • opacity?number
          • stroke?TextStrokeStyle
          • textOnCurve?TextCurveConfig
          • includeCharMetrics?boolean
          • measurementCanvas?{ width?: number; height?: number; }
        • variant 2
          TextProperties[]
          • variant 1TextProperties
BatchChainAssetOpts: BatchChainAssetOpts
  • resolveAssetRefs?boolean
  • resolve?AssetResolveFn
  • concurrency?number
  • signal?AbortSignal

Return value

Promise<Buffer<ArrayBufferLike>[]>

The return contract is generated from the packed declaration. Async wrappers and nullable/undefined variants remain visible in the type model.

Errors

NOT APPLICABLE — no verified errors are bound to this API.

Limits

NOT APPLICABLE — no API-specific verified limits are bound to this API.

Related APIs

No explicit related API metadata.

Next steps

ApexPainter._detectAPI member · node · CURRENT

Published ApexPainter._detect property.

ApexPainter._outputAPI member · node · CURRENT

Published ApexPainter._output property.

ApexPainter._outputFormatAPI member · node · CURRENT

Published ApexPainter._outputFormat property.

ApexPainter._path2dAPI member · node · CURRENT

Published ApexPainter._path2d property.