ApexPainter member
ApexPainter.saveMultiple
Published ApexPainter.saveMultiple method.
lib-next/apex-painter/main.ts (opens in a new tab)Signature
(buffers: Buffer[], options?: SaveOptions) => Promise<SaveResult[]>Parameters
buffers
Buffer<ArrayBufferLike>[]
options?
Options
| Option | Type | Contract | Allowed values | Runtime & capabilities |
|---|---|---|---|---|
| options | ||||
options.counterStartPublished options.counterStart option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.createDirectoryPublished options.createDirectory option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
options.directoryPublished options.directory option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.filenamePublished options.filename option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.formatPublished options.format option. | "jpg" | "png" | "jpeg" | "webp" | "avif" | "gif" | OptionalDefault— | 6 values"jpg" "png" "jpeg" "webp" "avif" "gif" | node22 · node24 · node26 |
options.namingPublished options.naming option. | "custom" | "timestamp" | "counter" | OptionalDefault— | "custom" "timestamp" "counter" | node22 · node24 · node26 |
options.overwritePublished options.overwrite option. | boolean | OptionalDefault— | false true | node22 · node24 · node26 |
options.prefixPublished options.prefix option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.qualityPublished options.quality option. | number | OptionalDefault— | — | node22 · node24 · node26 |
options.suffixPublished options.suffix option. | string | OptionalDefault— | — | node22 · node24 · node26 |
options.counterStart
OptionalPublished options.counterStart option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.createDirectory
OptionalPublished options.createDirectory option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
options.directory
OptionalPublished options.directory option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.filename
OptionalPublished options.filename option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.format
OptionalPublished options.format option.
- Type
"jpg" | "png" | "jpeg" | "webp" | "avif" | "gif"- Default
- —
- Allowed
6 values
"jpg""png""jpeg""webp""avif""gif"- Runtime
- node22, node24, node26
options.naming
OptionalPublished options.naming option.
- Type
"custom" | "timestamp" | "counter"- Default
- —
- Allowed
"custom""timestamp""counter"- Runtime
- node22, node24, node26
options.overwrite
OptionalPublished options.overwrite option.
- Type
boolean- Default
- —
- Allowed
falsetrue- Runtime
- node22, node24, node26
options.prefix
OptionalPublished options.prefix option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.quality
OptionalPublished options.quality option.
- Type
number- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
options.suffix
OptionalPublished options.suffix option.
- Type
string- Default
- —
- Allowed
- —
- Runtime
- node22, node24, node26
Types
SaveOptions: SaveOptions
- directory?
string - filename?
string - format?
"jpg" | "png" | "jpeg" | "webp" | "avif" | "gif"- variant 1
"jpg" - variant 2
"png" - variant 3
"jpeg" - variant 4
"webp" - variant 5
"avif" - variant 6
"gif"
- variant 1
- quality?
number - createDirectory?
boolean - naming?
"custom" | "timestamp" | "counter"- variant 1
"custom" - variant 2
"timestamp" - variant 3
"counter"
- variant 1
- counterStart?
number - prefix?
string - suffix?
string - overwrite?
boolean
Return value
Promise<SaveResult[]>
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.