Kiln API / kiln / Replayer

Class: Replayer

Plays a recording on an app that hasn't run Startup. Call play() to advance (all frames, or up to a frame); the app can be inspected and stepped between calls.

Constructors

Constructor

new Replayer(app, recording): Replayer;

Parameters

Parameter	Type
app	App
recording	Recording

Returns

Replayer

Properties

recording

readonly recording: Recording;

Accessors

frame

Get Signature

get frame(): number;

Frames played so far.

Returns

number

---

done

Get Signature

get done(): boolean;

True once every recorded frame has played.

Returns

boolean

---

status

Get Signature

get status(): ReplayResult;

Returns

ReplayResult

Methods

warnOnce()

warnOnce(text): void;

Adds a note to the result, once per distinct text. Plugins call it when a replay can't apply something.

Parameters

Parameter	Type
text	string

Returns

void

---

play()

play(until?): Promise<ReplayResult>;

Plays to frame until (default: the end). Events emitted during the replay stay readable with app.events(E).

Parameters

Parameter	Type
until	number

Returns

Promise<ReplayResult>