Skip to content

es cqrs.Interface.EventStoreProvider

Sclable CI edited this page Apr 10, 2026 · 35 revisions

@sclable/nestjs-libs / es-cqrs / EventStoreProvider

Interface: EventStoreProvider

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:19

EventStore provider interface

The user is responsible for implementing this interface to provide an event-store. If it is ommited, the default wolkenkit-eventstore will be used

Methods

close()

close(): Promise<void>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:39

Close event-store

Returns

Promise<void>


getEvents()

getEvents(aggregateId, fromRevision): Promise<Event[]>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:21

Get events for an aggregate

Parameters

aggregateId

string

fromRevision

number

Returns

Promise<Event[]>


getReplay()

getReplay(options?): Promise<Event[]>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:33

Get events to replay (default is all)

Parameters

options?

ReplayOptions

Returns

Promise<Event[]>


getReplayCount()

getReplayCount(options?): Promise<number>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:35

Get count of events to replay (default is all)

Parameters

options?

ReplayOptions

Returns

Promise<number>


getSnapshot()

getSnapshot(aggregateId): Promise<EventSourcedAggregate | undefined>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:29

Get the latest snapshot of an aggregate

Parameters

aggregateId

string

Returns

Promise<EventSourcedAggregate | undefined>


init()

init(): Promise<void>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:37

Init event-store

Returns

Promise<void>


saveEvents()

saveEvents(aggregate): Promise<void>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:27

Save events for an aggregate

Events are accessed through Aggregate.getUncommittedEvents()

Parameters

aggregate

Aggregate

Returns

Promise<void>


saveSnapshot()

saveSnapshot(aggregate): Promise<void>

Defined in: packages/es-cqrs/src/interfaces/event-store-provider.ts:31

Save a snapshot of an aggregate

Parameters

aggregate

EventSourcedAggregate

Returns

Promise<void>

Clone this wiki locally