DesignClient
Defined in: packages/core/src/adapters/design.ts:68
Runtime — bound to a credential, talks to the vendor API.
Methods
Section titled “Methods”fetchMetas()
Section titled “fetchMetas()”fetchMetas(
fileKey,refs,options?):Promise<Map<string,DesignMeta>>
Defined in: packages/core/src/adapters/design.ts:73
Metadata for several refs of one file, keyed by node id ("" = whole file).
API failures map to a DesignState per ref rather than throwing.
Parameters
Section titled “Parameters”fileKey
Section titled “fileKey”string
readonly DesignRef[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Map<string, DesignMeta>>
fetchRenders()
Section titled “fetchRenders()”fetchRenders(
fileKey,nodeIds,options?):Promise<Map<string,Buffer<ArrayBufferLike>>>
Defined in: packages/core/src/adapters/design.ts:82
PNG renders of several nodes of one file, keyed by node id. Nodes the vendor cannot render are omitted; throws when the render API call itself fails.
Parameters
Section titled “Parameters”fileKey
Section titled “fileKey”string
nodeIds
Section titled “nodeIds”readonly string[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Map<string, Buffer<ArrayBufferLike>>>