Interface Store

Stores events in streams and consumer subscriptions/leases

Hierarchy

Disposable
- Store

Index

Properties

commit dispose drop name query seed stats

Properties

commit

commit: (<E>(stream, events, metadata, expectedVersion?) => Promise<CommittedEvent<E>[]>)

Type declaration

- <E>(stream, events, metadata, expectedVersion?): Promise<CommittedEvent<E>[]>
- Commits message into stream of aggregate id
  Type Parameters
  - E extends Messages
  Parameters
  - stream: string
    
    stream name
  - events: Message<E>[]
    
    array of uncommitted events
  - metadata: CommittedEventMetadata
    
    metadata
  - Optional expectedVersion: number
    
    optional aggregate expected version to provide optimistic concurrency, raises concurrency exception when not matched
  Returns Promise<CommittedEvent<E>[]>
  array of committed events

dispose

dispose: Disposer

drop

drop: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Drops the store
  
  Returns Promise<void>

`Readonly` name

name: string

query

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

Type declaration

- <E>(callback, query?): Promise<number>
- Queries the event store
  Type Parameters
  - E extends Messages
  Parameters
  - callback: ((event) => void)
    
    callback predicate
    - (event): void
      
      Parameters
      
      event: CommittedEvent<E>
      
      Returns void
  - Optional query: AllQuery
    
    optional query values
  Returns Promise<number>
  number of records

seed

seed: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Seeds the store
  
  Returns Promise<void>

stats

stats: (() => Promise<StoreStat[]>)

Type declaration

- (): Promise<StoreStat[]>
- Gets store stats TODO: refactor stats using async projections
  
  Returns Promise<StoreStat[]>

Generated using TypeDoc