TestPath <TSnapshot, TEvent>

Hierarchy

• StatePath<TSnapshot, TEvent>
  • TestPath

Index

Properties

• description
• state
• steps
• test
• testSync
• weight

Properties

description

description: string

state

state: TSnapshot

Inherited from StatePath.state

The ending state of the path.

steps

steps: Steps<TSnapshot, TEvent>

Inherited from StatePath.steps

The ordered array of state-event pairs (steps) which reach the ending state.

test

test: (params: TestParam<TSnapshot, TEvent>) => Promise<TestPathResult>

Type declaration

• • (params: TestParam<TSnapshot, TEvent>): Promise<TestPathResult>

  • Tests and executes each step in steps sequentially, and then tests the postcondition that the state is reached.

    ---

    Parameters

    • params: TestParam<TSnapshot, TEvent>

    Returns Promise<TestPathResult>

testSync

testSync: (params: TestParam<TSnapshot, TEvent>) => TestPathResult

Type declaration

• • (params: TestParam<TSnapshot, TEvent>): TestPathResult

  • Parameters

    • params: TestParam<TSnapshot, TEvent>

    Returns TestPathResult

weight

weight: number

Inherited from StatePath.weight

The combined weight of all steps in the path.