Skip to content

@xstate/graph

Index

Functions

Interfaces

Type Aliases

Type Aliases

AnyStateNode

AnyStateNode: StateNode<any, any>

DirectedGraphEdge

DirectedGraphEdge: JSONSerializable<{ id: string; label: DirectedGraphLabel; source: AnyStateNode; target: AnyStateNode; transition: TransitionDefinition<any, any> }, { label: ReturnType<DirectedGraphLabel[toJSON]>; source: string; target: string }>

DirectedGraphLabel

DirectedGraphLabel: JSONSerializable<{ text: string }, { text: string }>

DirectedGraphNode

DirectedGraphNode: JSONSerializable<{ children: DirectedGraphNode[]; edges: DirectedGraphEdge[]; id: string; stateNode: StateNode }, { children: DirectedGraphNode[]; id: string }>

ExtractEvent

ExtractEvent<TEvent, TType>: TEvent extends { type: TType } ? TEvent : never

Type parameters

JSONSerializable

JSONSerializable<T, U>: T & { toJSON: () => U }

Type parameters

  • T: object
  • U

SerializationOptions

SerializationOptions<TSnapshot, TEvent>: Partial<Pick<SerializationConfig<TSnapshot, TEvent>, serializeState | serializeEvent>>

Type parameters

SerializedEvent

SerializedEvent: Brand<string, event>

SerializedState

SerializedState: Brand<string, state>

Steps

Steps<TSnapshot, TEvent>: Step<TSnapshot, TEvent>[]

Type parameters

TraversalOptions

TraversalOptions<TSnapshot, TEvent>: SerializationOptions<TSnapshot, TEvent> & Partial<Pick<TraversalConfig<TSnapshot, TEvent>, filter | events | traversalLimit | fromState | stopCondition | toState>>

Type parameters