Skip to content

es cqrs.EventStoreProvider

Sclable CI edited this page Sep 11, 2024 · 198 revisions

Interface: EventStoreProvider

es-cqrs.EventStoreProvider

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

Implemented by

Table of contents

Methods

Methods

close

close(): Promise<void>

Close event-store

Returns

Promise<void>

Defined in

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


getEvents

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

Get events for an aggregate

Parameters

Name Type
aggregateId string
fromRevision number

Returns

Promise<Event[]>

Defined in

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


getReplay

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

Get events to replay (default is all)

Parameters

Name Type
options? ReplayOptions

Returns

Promise<Event[]>

Defined in

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


getReplayCount

getReplayCount(options?): Promise<number>

Get count of events to replay (default is all)

Parameters

Name Type
options? ReplayOptions

Returns

Promise<number>

Defined in

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


getSnapshot

getSnapshot(aggregateId): Promise<undefined | EventSourcedAggregate>

Get the latest snapshot of an aggregate

Parameters

Name Type
aggregateId string

Returns

Promise<undefined | EventSourcedAggregate>

Defined in

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


init

init(): Promise<void>

Init event-store

Returns

Promise<void>

Defined in

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


saveEvents

saveEvents(aggregate): Promise<void>

Save events for an aggregate

Events are accessed through Aggregate.getUncommittedEvents()

Parameters

Name Type
aggregate Aggregate

Returns

Promise<void>

Defined in

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


saveSnapshot

saveSnapshot(aggregate): Promise<void>

Save a snapshot of an aggregate

Parameters

Name Type
aggregate EventSourcedAggregate

Returns

Promise<void>

Defined in

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

Clone this wiki locally