Class: FileCheckpointer

Defined in: state/checkpointer.ts:243

File-based checkpointer for simple persistence. Stores each session as a separate JSON file.

Implements

Constructors

Constructor 

new FileCheckpointer(baseDir, options?): FileCheckpointer;

Defined in: state/checkpointer.ts:248

Parameters

Parameter Type
baseDir string
options? FileCheckpointerOptions

Returns

FileCheckpointer

Methods

delete() 

delete(sessionId): Promise<boolean>;

Defined in: state/checkpointer.ts:397

Delete a session

Parameters

Parameter Type
sessionId string

Returns

Promise<boolean>

Implementation of

Checkpointer.delete

exists() 

exists(sessionId): Promise<boolean>;

Defined in: state/checkpointer.ts:432

Check if session exists

Parameters

Parameter Type
sessionId string

Returns

Promise<boolean>

Implementation of

Checkpointer.exists

getMetadata() 

getMetadata(sessionId): Promise<SessionMetadata | null>;

Defined in: state/checkpointer.ts:446

Get session metadata

Parameters

Parameter Type
sessionId string

Returns

Promise<SessionMetadata | null>

Implementation of

Checkpointer.getMetadata

list() 

list(options?): Promise<SessionInfo[]>;

Defined in: state/checkpointer.ts:343

List all sessions

Parameters

Parameter Type
options? ListSessionsOptions

Returns

Promise<SessionInfo[]>

Implementation of

Checkpointer.list

load() 

load(sessionId): Promise<AgentState | null>;

Defined in: state/checkpointer.ts:323

Load state from file

Parameters

Parameter Type
sessionId string

Returns

Promise<AgentState | null>

Implementation of

Checkpointer.load

save() 

save(
   sessionId, 
   state, 
metadataOverrides?): Promise<void>;

Defined in: state/checkpointer.ts:288

Save state to file

Pre-validates state before saving to prevent corrupted checkpoints. This catches issues like invalid data types that would fail on reload.

Parameters

Parameter Type
sessionId string
state AgentState
metadataOverrides? Partial<SessionMetadata>

Returns

Promise<void>

Implementation of

Checkpointer.save