Interface TranscriptRecorder<P>

Handle returned by recordTranscript.

interface TranscriptRecorder<P extends IProvider = IProvider> {
    provider: RecordingProvider<P>;
    transcript(meta?: { name?: string; description?: string }): Transcript;
    clear(): void;
    pause(): void;
    resume(): void;
}

Type Parameters

P extends IProvider = IProvider

Index

Properties

Methods

transcript clear pause resume

Properties

`Readonly`provider

provider: RecordingProvider<P>

The recording provider to hand to new Bot({ provider }).

Methods

transcript

transcript(meta?: { name?: string; description?: string }): Transcript
Snapshot of the turns recorded so far as a transcript.
Parameters
- Optionalmeta: { name?: string; description?: string }
Returns Transcript
- Defined in testing/transcripts/record.ts:59

clear

clear(): void
Forget everything recorded so far (the clock restarts on the next turn).

Returns void
- Defined in testing/transcripts/record.ts:61

pause

pause(): void
Stop recording; the provider keeps forwarding traffic.

Returns void
- Defined in testing/transcripts/record.ts:63

resume

resume(): void
Resume recording after pause.

Returns void
- Defined in testing/transcripts/record.ts:65