IHistory | when-ts

The HistoryManager interface allows for state manipulation and the rewinding of a program.

Type parameters

S: MachineState
I: MachineInputSource

Hierarchy

IHistory

Index

Properties

Methods

clear
rewind

Properties

currentState

currentState: Readonly<S & I>

initialState

initialState: Readonly<S>

limit

limit: number

Limit the maximum number of past history states kept on record.

nextState

nextState: Readonly<Partial<S> & I>

records

records: ReadonlyArray<S & Readonly<I>>

tick

tick: number

Methods

clear

clear(): void

- Defined in interfaces.ts:79
Clears the state history. Rewinds to the beginning, and the rest of the current tick will be aborted.

Returns void

rewind

rewind(t: number, mutate?: Partial<S>): void

- Defined in interfaces.ts:74
Rewind time to t, the rest of the currently executing tick will be ignored. A partial state can be passed as the second argument to mutate the rewound state and take back information to the past state.

Parameters
- t: number
  
  The discrete tick in time to rewind to.
- Optional mutate: Partial<S>
  
  Any mutations to apply to the state after rewinding.
Returns void

Generated using TypeDoc