toEnvironmentSpec

Returns the part of an environment definition the compiler needs, as an EnvironmentSpec.

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

A definition with a pre-built compile spec returns that same object, so registering the definition after the spec has already been registered for a server compile is a no-op rather than a conflict. Otherwise the inline attributes, vocabulary and body fields assemble a spec.

#Signature

(def: EnvironmentDefinition): EnvironmentSpec

#Parameters

def
The definition to take the compile side of.

#Returns

The definition's compile spec, or one assembled from its inline fields.

Declared in packages/canvas-sdk/src/environment/defineEnvironment.ts:72.

Last updated