Class Checkpoints

Creates and persists session checkpoints.

const checkpoints = new Checkpoints(sessionId, { backend: 'local_storage', maxCheckpoints: 20 });
await checkpoints.save('Completed exercise 3', { exerciseId: 'ex-3', score: 0.9 });
const all = checkpoints.getAll();

Index

Constructors

constructor

Methods

clear getAll getLatest save

Constructors

constructor

new Checkpoints(sessionId: SessionId, config: CheckpointsConfig): Checkpoints
Creates a new Checkpoints manager bound to a session.
Parameters
- sessionId: SessionId
  The session whose checkpoints are being managed.
- config: CheckpointsConfig
  Backend and retention settings.
Returns Checkpoints
- Defined in apps/tutor/src/session/Checkpoints.ts:62

Methods

clear

clear(): Promise<void>
Deletes all persisted checkpoints for this session from the backend.

Returns Promise<void>
Resolves once the storage backend has cleared the data.
- Defined in apps/tutor/src/session/Checkpoints.ts:103

getAll

getAll(): Checkpoint[]
Returns all checkpoints for this session, ordered oldest-first.

Returns Checkpoint[]
An ordered array of Checkpoint objects.
- Defined in apps/tutor/src/session/Checkpoints.ts:85

getLatest

getLatest(): Checkpoint | null
Returns the most recently saved checkpoint, or null if none exist.

Returns Checkpoint | null
The latest Checkpoint, or null.
- Defined in apps/tutor/src/session/Checkpoints.ts:94

save

save(label: string, metadata?: Record<string, unknown>): Promise<Checkpoint>
Creates and persists a new checkpoint for the current moment.
Parameters
- label: string
  Human-readable label, e.g. "Completed exercise 3".
- Optionalmetadata: Record<string, unknown>
  Arbitrary key-value data to record with the checkpoint.
Returns Promise<Checkpoint>
The newly created and persisted Checkpoint.
- Defined in apps/tutor/src/session/Checkpoints.ts:73

Class Checkpoints

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Checkpoints

Methods

clear

Returns Promise<void>

getAll

Returns Checkpoint[]

getLatest

Returns Checkpoint | null

save

Parameters

Returns Promise<Checkpoint>

Settings

On This Page