buildCanvasLibrary

Returns a copy of a library with every registered environment folded in: the environment nodes, their vocabularies and value types, and the widened scene and cue policies.

@internote/canvas-sdkFunction
On this page
import { buildCanvasLibrary } from '@internote/canvas-sdk';

Declares each environment node and its vocabulary, admits the environment nodes into the scene detail, widens the cue family's child policies to the registered vocabularies, and puts the control family in every environment's body. Animatable attributes are emitted as strings, since a keyframe chain cannot pass a native value parser; the declared type still governs refinement afterwards. With nothing registered the copy is returned untouched. Throws an EnvironmentRegistrationError when an environment or vocabulary element collides with a node the base already declares differently.

#Signature

(base: ChalkLibrary): ChalkLibrary

#Parameters

base
The library to fold the environments into. Not mutated.

Declared in packages/canvas-sdk/src/environment/library-build.ts:252.

Last updated