Skip to content

@xstate/test

Index

Classes

Functions

Interfaces

Type Aliases

Type Aliases

EventExecutor

EventExecutor<TSnapshot, TEvent>: (step: Step<TSnapshot, TEvent>) => Promise<any> | void

Type parameters

Type declaration

    • (step: Step<TSnapshot, TEvent>): Promise<any> | void

    • Executes an effect using the testContext and event that triggers the represented event.

      Parameters

      • step: Step<TSnapshot, TEvent>

      Returns Promise<any> | void

GetPathsOptions

GetPathsOptions<TSnapshot, TEvent, TInput>: Partial<TraversalOptions<TSnapshot, TEvent> & { pathGenerator?: PathGenerator<TSnapshot, TEvent, TInput> }>

Type parameters

PathGenerator

PathGenerator<TSnapshot, TEvent, TInput>: (behavior: ActorLogic<TSnapshot, TEvent, TInput>, options: TraversalOptions<TSnapshot, TEvent>) => StatePath<TSnapshot, TEvent>[]

Type parameters

Type declaration

StatePredicate

StatePredicate<TState>: (state: TState) => boolean

Type parameters

  • TState

Type declaration

    • (state: TState): boolean

    • Parameters

      • state: TState

      Returns boolean

TestMachineOptions

TestMachineOptions<TContext, TEvent, TTypesMeta>: Partial<Pick<MachineImplementations<TContext, TEvent, any, ParameterizedObject, ParameterizedObject, string, string, TTypesMeta>, actions | guards>>

Type parameters

TestTransitionsConfig

TestTransitionsConfig<TContext, TEvent, TTestContext>: { [ K in TEvent[type] | | * ]?: K extends | * ? TestTransitionConfig<TContext, TEvent, TTestContext> | string : TestTransitionConfig<TContext, ExtractEvent<TEvent, K>, TTestContext> | string }

Type parameters