Class SimpleEventLog<T>

Abstract interface representing an event log

Type Parameters

T extends LogEntry

Implements

EventLog<T>

Index

Constructors

Methods

addEntry query setMetadata truncate

Constructors

constructor

new SimpleEventLog<T extends LogEntry>(): SimpleEventLog<T>
Type Parameters
- T extends LogEntry
Returns SimpleEventLog<T>
- Defined in SimpleEventLog.ts:8

Methods

addEntry

addEntry(entry: T, sequenceId: bigint): ResultAsync<void, AddEntryError>
Add an entry to the log with the given sequence id

The sequenceId must be the next available sequence id in the log. This is returned as endSequenceId when making a query for the last entry in the log. Returns a ConflictError if not the next available id. Any other problem with serializing the entry will return a StorageError.
Parameters
- entry: T
- sequenceId: bigint
Returns ResultAsync<void, AddEntryError>
Implementation of EventLog.addEntry
- Defined in SimpleEventLog.ts:14

query

query(
start: bigint | "snapshot" | "start",
end: bigint | "end",
): ResultAsync<QueryValue<T>, QueryError>
Return a range of entries from first to last inclusive

The event log may return fewer entries than requested. If so, repeat the query starting from nextSequenceId.
Parameters
- start: bigint | "snapshot" | "start"
  SequenceId of first entry to return. Use 'start' to query from the first entry in the log. Use 'snapshot' to query from the most recent entry with a snapshot, or the first if no snapshot is defined.
- end: bigint | "end"
  SequenceId one after the last entry to return. Use 'end' to query everything to the end of the log.
Returns ResultAsync<QueryValue<T>, QueryError>
Implementation of EventLog.query
- Defined in SimpleEventLog.ts:39

setMetadata

setMetadata(
sequenceId: bigint,
metadata: LogMetadata,
): ResultAsync<void, MetadataError>
Set some or all of a log entry's metadata fields

Changes are atomic. Either all of the specified fields are updated or none are.
Parameters
- sequenceId: bigint
- metadata: LogMetadata
Returns ResultAsync<void, MetadataError>
Implementation of EventLog.setMetadata
- Defined in SimpleEventLog.ts:23

truncate

truncate(start: bigint): ResultAsync<void, TruncateError>
All entries prior to start are removed from the log.
Parameters
- start: bigint
Returns ResultAsync<void, TruncateError>
Implementation of EventLog.truncate
- Defined in SimpleEventLog.ts:67