Sitelet https://form-nodes.js.org/reference/types/array-node
Skip to main content

ArrayNode

Array node model. Omit the first type argument for an unspecified structure, or provide it to preserve exact item types. Generic array nodes retain array operations.

Import​

import type { ArrayNode } from '@ngblocks/form-nodes';

When to use it​

Use for dynamic collections whose first generic is the item node type. Read items and use array operations through the inferred API rather than treating this as a JavaScript array of raw values.

Declaration​

type ArrayNode<TItem extends AnyNode = AnyNode, TParent extends AnyNode = AnyNode> = NodeSignal<ArrayValue<TItem>> & {
    (): ArrayValue<TItem>;
    $api: CallableNodeApi<ArrayApi<TItem, TParent>>;
} & ArrayIndexes<TItem, TParent> & ArrayApi<TItem, TParent> & HiddenFunctionMembers<keyof ArrayApi<TItem, TParent>>;

Type parameters​

ParameterConstraintDefault
TItemAnyNodeAnyNode
TParentAnyNodeAnyNode

Declared members​

The declaration above also includes inherited contracts and overloads where applicable.

MemberMeaning
$apiCallable, collision-safe access to the array API. Calling $api() reads the same exposed value as the node and tracks signal dependencies. Use direct members for application code and $api for generic code or child-name collisions.
Last updated on