Interface ProjectorStore<S>

Stores projections

Type Parameters

S extends State = State

Hierarchy

Disposable
- ProjectorStore

Index

Properties

agg commit dispose drop load name query seed

Properties

agg

agg: ((query) => Promise<AggResult<S>>)

Type declaration

- (query): Promise<AggResult<S>>
- Aggregates projection
  Parameters
  - query: AggQuery<S>
    
    aggregate query
  Returns Promise<AggResult<S>>
  aggregate results

commit

commit: ((map, watermark) => Promise<ProjectionResults>)

Type declaration

- (map, watermark): Promise<ProjectionResults>
- Commits projection map with basic idempotence check
  Parameters
  - map: ProjectionMap<S>
    
    the projection map
  - watermark: number
    
    the new watermark - ignored when new watermark <= stored watermark
  Returns Promise<ProjectionResults>
  the projection results

dispose

dispose: Disposer

drop

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

Type declaration

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

load

load: ((ids) => Promise<ProjectionRecord<S>[]>)

Type declaration

- (ids): Promise<ProjectionRecord<S>[]>
- Loads projection records by id
  Parameters
  - ids: string[]
    
    the record ids
  Returns Promise<ProjectionRecord<S>[]>
  the stored records by id

`Readonly` name

name: string

query

query: ((query) => Promise<ProjectionRecord<S>[]>)

Type declaration

- (query): Promise<ProjectionRecord<S>[]>
- Queries projection
  Parameters
  - query: ProjectionQuery<S>
    
    projection query
  Returns Promise<ProjectionRecord<S>[]>
  array of records found

seed

seed: ((schema, indexes) => Promise<void>)

Type declaration

- (schema, indexes): Promise<void>
- Seeds the store
  Parameters
  - schema: Schema<Projection<S>>
  - indexes: ProjectionSort<S>[]
  Returns Promise<void>

Generated using TypeDoc