Interface Sorci

Namespace

Hierarchy

Sorci

Implemented by

SorciPostgres

Index

Methods - Stream

appendEvent getEventById getEventsByQuery

Methods - Tooling

createStream dropAllTestStream dropCurrentStream insertEvents setupTestStream truncate

Stream Methods

appendEvent

appendEvent(payload: AppendEventPayload): Promise<string>
Will append an event. It will make sure there is no concurrency issue if query & eventIdentifier is provided

Returns
The event id
Parameters
- payload: AppendEventPayload
Returns Promise<string>
- Defined in sorci.interface.ts:125

getEventById

getEventById(id: string): Promise<undefined | PersistedEvent>
Will retrieve one event by it's id
Parameters
- id: string
Returns Promise<undefined | PersistedEvent>
- Defined in sorci.interface.ts:133

getEventsByQuery

getEventsByQuery(query: Query): Promise<PersistedEvent[]>
Will retrieve every event that match the Query
Parameters
- query: Query
Returns Promise<PersistedEvent[]>
- Defined in sorci.interface.ts:139

Tooling Methods

createStream

createStream(): Promise<void>
Will create necessary tables, function & triggers

Returns Promise<void>
- Defined in sorci.interface.ts:79

dropAllTestStream

dropAllTestStream(payload?: {
excludeCurrentStream: boolean;
}): Promise<void>
Will destroy every stream prefixed by 'test-' Usefull to cleanup all test stream
Parameters
- Optional payload: {
  excludeCurrentStream: boolean;
  }
  - excludeCurrentStream: boolean
Returns Promise<void>
- Defined in sorci.interface.ts:115

dropCurrentStream

dropCurrentStream(): Promise<void>
Will drop the current stream Usefull to cleanup a test stream

Returns Promise<void>
- Defined in sorci.interface.ts:108

insertEvents

insertEvents(events: ToPersistEvent[]): Promise<string[]>
Will insert events in the stream without any concurrency check Usefull to setup a test stream with a lot of events

Returns
An array of event id
Parameters
- events: ToPersistEvent[]
Returns Promise<string[]>
- Defined in sorci.interface.ts:93

setupTestStream

setupTestStream(streamName?: string): Promise<void>
Will create a stream with random name prefixed by 'test-' Usefull to setup a test stream

Remarks
You can give a name to the stream if you want to
Parameters
- Optional streamName: string
Returns Promise<void>
- Defined in sorci.interface.ts:101

truncate

truncate(): Promise<void>
Will remove every events of the stream

Returns Promise<void>
- Defined in sorci.interface.ts:85

Generated using TypeDoc