Skip to content

StateNode

Defined in: src/types/index.ts:168

A positioned graph node in the internal diagram model, produced from an ASL state.

optional assignedVariables?: string[];

Defined in: src/types/index.ts:173

Names of the variables a state assigns via ASL Assign, in declaration order. Empty/absent when the state assigns nothing.


optional children?: string[];

Defined in: src/types/index.ts:175

Child node IDs (for container nodes like Parallel/Map)


optional collapsed?: boolean;

Defined in: src/types/index.ts:177

Whether this container node is a collapse placeholder (its subgraph was removed).


optional collapsedCount?: number;

Defined in: src/types/index.ts:179

Number of real descendant states hidden behind a collapsed container placeholder.


optional failCause?: string;

Defined in: src/types/index.ts:184

A Fail state’s cause, pre-formatted for display (e.g. cause: Payment declined, or the path or JSONata expression it is read from). Absent for other state types.


optional failError?: string;

Defined in: src/types/index.ts:189

A Fail state’s error name, pre-formatted for display (e.g. error: PaymentFailed, or the path or JSONata expression it is read from). Absent for other state types.


optional height?: number;

Defined in: src/types/index.ts:190


optional iconUrl?: string;

Defined in: src/types/index.ts:192

URL to AWS service icon (CDN path for Task states)


id: string;

Defined in: src/types/index.ts:193


optional inputArguments?: string;

Defined in: src/types/index.ts:199

The Arguments a JSONata-mode state passes to its integration, pre-formatted for display (e.g. args FunctionName, Payload). Absent when not set. Not named arguments, which cannot be destructured in strict-mode code.


optional integrationPattern?: string;

Defined in: src/types/index.ts:205

A Task state’s service integration pattern, pre-formatted for display: sync for a .sync / .sync:2 resource, callback for .waitForTaskToken. Absent for a request-response Task.


optional isContainer?: boolean;

Defined in: src/types/index.ts:211

Whether this node is a container (a Parallel or Map state) with nested states drawn inside it. A Parallel with no branches or a Map with no processor has nothing to contain and is a plain node instead.


optional isDistributedMap?: boolean;

Defined in: src/types/index.ts:213

Whether this Map state runs in distributed mode (ProcessorConfig.Mode: 'DISTRIBUTED')


optional itemBatching?: string;

Defined in: src/types/index.ts:218

A Map state’s ItemBatcher sizing, pre-formatted for display (e.g. batches of 50). Absent when the Map does not batch.


optional itemSelector?: string;

Defined in: src/types/index.ts:223

How a Map state shapes each item for its processor, pre-formatted for display (e.g. selector item, index). Absent when the Map sets no ItemSelector.


optional itemsPath?: string;

Defined in: src/types/index.ts:228

The array a Map state iterates, pre-formatted for display (e.g. items $.orders). Absent when the Map sets no ItemsPath.


label: string;

Defined in: src/types/index.ts:229


optional mapLabel?: string;

Defined in: src/types/index.ts:234

A Distributed Map’s child-execution name prefix, pre-formatted for display (e.g. label OrderBatch). Absent when the Map sets no Label.


optional maxConcurrency?: string | number;

Defined in: src/types/index.ts:239

A Map state’s MaxConcurrency, when set. Displayed on the container header. A JSONata expression is stored unwrapped ($limit, not {% $limit %}).


optional output?: string;

Defined in: src/types/index.ts:244

The Output a JSONata-mode state produces, pre-formatted for display (e.g. output orderId, total). Absent when not set.


optional parent?: string;

Defined in: src/types/index.ts:246

Parent node ID (for nodes inside Parallel/Map containers)


optional serviceType?: string;

Defined in: src/types/index.ts:248

AWS service identifier for Task states (e.g., ‘lambda’, ‘s3’)


optional style?: NodeStyle;

Defined in: src/types/index.ts:249


optional taskHeartbeat?: string;

Defined in: src/types/index.ts:254

A Task state’s heartbeat interval, pre-formatted for display (e.g. heartbeat 10s, or the path or JSONata expression it is read from). Absent when not set.


optional taskTimeout?: string;

Defined in: src/types/index.ts:259

A Task state’s timeout, pre-formatted for display (e.g. timeout 30s, or the path or JSONata expression it is read from). Absent when not set.


optional toleratedFailure?: string;

Defined in: src/types/index.ts:264

A Map state’s failure tolerance, pre-formatted for display (e.g. tolerate 5%). Absent when no tolerance is configured.


type: string;

Defined in: src/types/index.ts:265


optional waitDuration?: string;

Defined in: src/types/index.ts:270

How long a Wait state waits, pre-formatted for display (e.g. 5s, or the path or JSONata expression the duration is read from). Absent for other state types.


optional width?: number;

Defined in: src/types/index.ts:271


optional x?: number;

Defined in: src/types/index.ts:272


optional y?: number;

Defined in: src/types/index.ts:273