Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/sessions / / SessionExportWriter

Interface: SessionExportWriter

Defined in: packages/sessions/src/export/writer.ts:88

Streaming writer. Call writeRecord(...) per body record (in any order, but kind: 'meta' and kind: 'footer' are owned by the writer) and close() to emit the footer. The writer itself does not own the destination — every emission is delivered via the caller-supplied sink.

Stable

Methods

close()

ts
close(): Promise<SessionExportFooterRecord>;

Defined in: packages/sessions/src/export/writer.ts:92

Emit the footer + any opt-in --hash body checksum. Idempotent.

Returns

Promise&lt;SessionExportFooterRecord&gt;


writeRecord()

ts
writeRecord(record): Promise<void>;

Defined in: packages/sessions/src/export/writer.ts:90

Write a single body record. The header is emitted lazily.

Parameters

ParameterType
recordSessionExportRecord

Returns

Promise&lt;void&gt;