Skip to content

Function: defineElement() ​

Call Signature ​

defineElement<E, P>(definition): SourceElementDefinition<E, P>

Checks an element definition and returns it with its types preserved. The instance init returns gets a read-only definition property pointing at the returned object. Invalid definitions throw TypeError, since they're programming errors.

Type Parameters ​

E ​

E extends SourceElement

P ​

P extends readonly (keyof ElementInterfaces)[] = []

Parameters ​

definition ​

SourceElementDefinition<E, P>

Returns ​

SourceElementDefinition<E, P>

Call Signature ​

defineElement<E, P>(definition): TransformElementDefinition<E, P>

Checks an element definition and returns it with its types preserved. The instance init returns gets a read-only definition property pointing at the returned object. Invalid definitions throw TypeError, since they're programming errors.

Type Parameters ​

E ​

E extends TransformElement

P ​

P extends readonly (keyof ElementInterfaces)[] = []

Parameters ​

definition ​

TransformElementDefinition<E, P>

Returns ​

TransformElementDefinition<E, P>

Call Signature ​

defineElement<E, P>(definition): SinkElementDefinition<E, P>

Checks an element definition and returns it with its types preserved. The instance init returns gets a read-only definition property pointing at the returned object. Invalid definitions throw TypeError, since they're programming errors.

Type Parameters ​

E ​

E extends SinkElement

P ​

P extends readonly (keyof ElementInterfaces)[] = []

Parameters ​

definition ​

SinkElementDefinition<E, P>

Returns ​

SinkElementDefinition<E, P>