Skip to main content

Store

@rotorsoft/act-root

@rotorsoft/act-root / act/src / Store

Interface: Store

Defined in: libs/act/src/types/ports.ts:31

Interface for an event store implementation. Provides methods for seeding, dropping, committing, querying, and managing event streams.

Extends​

Properties​

ack()​

ack: (leases) => Promise<void>

Defined in: libs/act/src/types/ports.ts:88

Acknowledge completion of processing for leased streams.

Parameters​

leases​

Lease[]

Leases to acknowledge.

Returns​

Promise<void>

commit()​

commit: <E>(stream, msgs, meta, expectedVersion?) => Promise<Committed<E, keyof E>[]>

Defined in: libs/act/src/types/ports.ts:50

Commit one or more events to a stream.

Type Parameters​

E​

E extends Schemas

Parameters​

stream​

string

The stream name.

msgs​

Message<E, keyof E>[]

The events/messages to commit.

meta​

EventMeta

Event metadata.

expectedVersion?​

number

Optional optimistic concurrency check.

Returns​

Promise<Committed<E, keyof E>[]>

The committed events with metadata.

Throws​

ConcurrencyError if expectedVersion does not match.

dispose​

dispose: Disposer

Defined in: libs/act/src/types/ports.ts:25

Inherited from​

Disposable.dispose

drop()​

drop: () => Promise<void>

Defined in: libs/act/src/types/ports.ts:39

Drop all data from the store (optional, for testing/dev).

Returns​

Promise<void>

fetch()​

fetch: <E>(limit) => Promise<Fetch<E>>

Defined in: libs/act/src/types/ports.ts:75

Fetch new events from stream watermarks for processing.

Type Parameters​

E​

E extends Schemas

Parameters​

limit​

number

Maximum number of streams to fetch.

Returns​

Promise<Fetch<E>>

Fetched streams and events.

lease()​

lease: (leases) => Promise<Lease[]>

Defined in: libs/act/src/types/ports.ts:82

Lease streams for processing (e.g., for distributed consumers).

Parameters​

leases​

Lease[]

Lease requests.

Returns​

Promise<Lease[]>

Granted leases.

query()​

query: <E>(callback, query?, withSnaps?) => Promise<number>

Defined in: libs/act/src/types/ports.ts:64

Query events in the store, optionally filtered by query options.

Type Parameters​

E​

E extends Schemas

Parameters​

callback​

(event) => void

Function to call for each event.

query?​

Optional query options.

after?​

number = ...

backward?​

boolean = ...

before?​

number = ...

correlation?​

string = ...

created_after?​

Date = ...

created_before?​

Date = ...

limit?​

number = ...

names?​

string[] = ...

stream?​

string = ...

withSnaps?​

boolean

Whether to include snapshot events.

Returns​

Promise<number>

The number of events processed.

seed()​

seed: () => Promise<void>

Defined in: libs/act/src/types/ports.ts:35

Seed the store with initial data (optional, for testing/dev).

Returns​

Promise<void>