Replay

webDeveloper

The ScaleBun.replay namespace — 8 members.

Updated August 12, 2026Reviewed August 7, 2026

TypeScript

import ScaleBun from '@scalebun/web';
ScaleBun.replay.<method>(…);

Members#

Member	Signature
`stats`	`stats(): ReplayStats \| null`
`checkpoint`	`checkpoint(reason?: string): void`
`flush`	`flush(): void`
`stop`	`stop(): void`
`start`	`start(): void`
`pause`	`pause(): void`
`resume`	`resume(): void`
`setPrivacy`	`setPrivacy(policy: { maskAllText?: boolean }): void`

Reference#

stats#

TypeScript

ScaleBun.replay.stats(): ReplayStats | null

Live diagnostics — mode/sample bucket, adaptive quality level, segments, dropped/shed counts. null when replay isn't recording (off, or a non-sampled session).

checkpoint#

TypeScript

ScaleBun.replay.checkpoint(reason?: string): void

Force a re-keyframe so the player gets a clean seek point before a risky flow.

flush#

TypeScript

ScaleBun.replay.flush(): void

Promote the buffered pre-roll → live capture now (e.g. the user clicked "report a problem").

stop#

TypeScript

ScaleBun.replay.stop(): void

Stop recording for this session.

start#

TypeScript

ScaleBun.replay.start(): void

Resume capture after pause() (re-keyframes the current DOM). Alias of resume().

pause#

TypeScript

ScaleBun.replay.pause(): void

Pause capture without ending the session — the buffered pre-roll is kept.

resume#

TypeScript

ScaleBun.replay.resume(): void

Resume capture after pause().

setPrivacy#

TypeScript

ScaleBun.replay.setPrivacy(policy: { maskAllText?: boolean }): void

Change replay text-masking at runtime, e.g. mask on a sensitive screen: setPrivacy({ maskAllText: true }).