ReplayControls

^{ref / conversations / ReplayControls}

Controls for a replay. This is the object that a ReplayEngine passes to the replay function when executing it.

^Source

Methods

interrupt

interrupt(key: string): Promise<unknown>;

Interrupts the current replay and record this event in the replay logs. The replay will finish with an Interrupted result.

Use ReplayEngine.supply to supply the result of this interrupt to the underlying replay state. When replaying the modified state, this call to interrupt will resolve with the supplied value.

You also need to pass a key that identifies this type of interrupt. It is stored in the replay state and will be collated with the key that is passed to interrupt during the repeated call. If the two keys do not match, this means that a bad replay was detected and an error will be thrown. You should discard the replay state and restart the replay from scratch.

^Source

cancel

cancel(message?: unknown): Promise<never>;

Cancels the replay. This tells the replay engine that a supplied interrupt value should be rejected. The replay will finish with a Canceled result.

A message object can be passed to cancel. This can be used to communicate to the caller why the interrupt value was rejected.

^Source

action

action<R = unknown>(fn: () => R | Promise<R>, key: string): Promise<R>;

Performs an action.

Actions are a way to signal to the replay engine that a particular piece of code should not be run repeatedly. The result of the action will be stored in the underlying replay log. During a subsequent replay, the action will not be repeated. Instead, the return is taken from the replay log.

You also need to pass a key that identifies this type of action. It is stored in the replay state and will be collated with the key that is passed to action during the repeated call. If the two keys do not match, this means that a bad replay was detected and an error will be thrown. You should discard the replay state and restart the replay from scratch.

^Source

checkpoint

checkpoint(): Checkpoint;

Creates a checkpoint at the current position of the replay. This can be passed to ReplayEngine.reset in order to restart a replay from an arbitrary position.

^Source