TranscriptRecorder<P>

Interface exported by @botmesh/core.

Defined in: testing/transcripts/record.ts:67

Handle returned by recordTranscript.

Type Parameters

Type Parameter	Default type
P extends IProvider	IProvider

Properties

provider

readonly provider: RecordingProvider<P>;

Defined in: testing/transcripts/record.ts:69

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

Methods

transcript()

transcript(meta?): Transcript;

Defined in: testing/transcripts/record.ts:71

Snapshot of the turns recorded so far as a transcript.

Parameters

Parameter	Type
meta?	{ name?: string; description?: string; }
meta.name?	string
meta.description?	string

Returns

Transcript

---

clear()

clear(): void;

Defined in: testing/transcripts/record.ts:73

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

Returns

void

---

pause()

pause(): void;

Defined in: testing/transcripts/record.ts:75

Stop recording; the provider keeps forwarding traffic.

Returns

void

---

resume()

resume(): void;

Defined in: testing/transcripts/record.ts:77

Resume recording after pause.

Returns

void