Skip to content

rulvar API reference


rulvar API reference / @rulvar/rulvar / FileTranscriptStore

Class: FileTranscriptStore

Defined in: packages/core/dist/index.d.ts

File-backed TranscriptStore (M6-T02): blobs (transcripts, checkpoints, persisted CompiledWorkflow sources) as one file per ref under dir, so compiled runs resume across processes. Refs follow the <runId>/<name> convention; each path segment is checked filesystem-safe and nested segments become directories.

Implements

Constructors

Constructor

ts
new FileTranscriptStore(options): FileTranscriptStore;

Defined in: packages/core/dist/index.d.ts

Parameters

ParameterType
options{ dir: string; }
options.dirstring

Returns

FileTranscriptStore

Methods

delete()

ts
delete(ref): Promise<void>;

Defined in: packages/core/dist/index.d.ts

Deletes one blob; a missing ref is a no-op, never an error (M8-T04 amendment, OQ-20: retention is impossible without blob deletion). The cascade over a run's blobs is ENGINE-side (Engine.deleteRun), never a store obligation.

Parameters

ParameterType
refstring

Returns

Promise&lt;void&gt;

Implementation of

TranscriptStore.delete


get()

ts
get(ref): Promise<Bytes | null>;

Defined in: packages/core/dist/index.d.ts

Parameters

ParameterType
refstring

Returns

Promise&lt;Bytes | null&gt;

Implementation of

TranscriptStore.get


list()

ts
list(runId): Promise<string[]>;

Defined in: packages/core/dist/index.d.ts

Parameters

ParameterType
runIdstring

Returns

Promise&lt;string[]&gt;

Implementation of

TranscriptStore.list


put()

ts
put(ref, blob): Promise<void>;

Defined in: packages/core/dist/index.d.ts

Parameters

ParameterType
refstring
blobBytes

Returns

Promise&lt;void&gt;

Implementation of

TranscriptStore.put