Kiln API / kiln / Recorder

Class: Recorder

Records a session. Create it before Startup (before app.boot() or app.start()).

Constructors

Constructor

new Recorder(app, options?): Recorder;

Parameters

Parameter	Type
app	App
options	RecorderOptions

Returns

Recorder

Properties

checkEvery

readonly checkEvery: number;

---

checkPrecision

readonly checkPrecision: number;

Accessors

frame

Get Signature

get frame(): number;

Frames recorded so far.

Returns

number

---

recording

Get Signature

get recording(): boolean;

True until stop().

Returns

boolean

Methods

note()

note(kind, data): void;

Notes a side-channel event; it applies before the next frame, as it did live. Plugins call this.

Parameters

Parameter	Type
kind	string
data	unknown

Returns

void

---

addNote()

addNote(text): void;

Adds a line to the recording's notes.

Parameters

Parameter	Type
text	string

Returns

void

---

take()

take(): Recording;

The recording so far. Recording continues.

Returns

Recording

---

stop()

stop(): Recording;

Stops recording and returns the recording.

Returns

Recording