Interface ReplicateEventsOptions<K, V, QueryExt>

Options of a replicateEvents call.

interface ReplicateEventsOptions {
    batchSize?: number;
    extra?: QueryExt;
    limit?: number;
    signal?: AbortSignal;
    since?: K[];
    source: EventStoreQuery<K, V, QueryExt>;
    target: AutoKeyMapPutBatch<K, V> & MaybeAsyncReadonlySetBatch<K>;
}

Type Parameters

K
V
QueryExt extends object

Hierarchy

AbortOptions
- ReplicateEventsOptions

Index

Properties

batchSize? extra? limit? signal? since? source target

Properties

`Optional` batchSize

batchSize?: number

Number of events to push at a time.

`Optional` extra

extra?: QueryExt

Extra query parameters to filter events.

`Optional` limit

limit?: number

Maximum number of events to replicate.

`Optional` signal

signal?: AbortSignal

An optional AbortSignal that can be used to abort an async task.

`Optional` since

since?: K[]

Last checkpoint to start replication from.

source

source: EventStoreQuery<K, V, QueryExt>

Local event store to replicate from.

target

target: AutoKeyMapPutBatch<K, V> & MaybeAsyncReadonlySetBatch<K>

Remote event store to replicate to.

Generated using TypeDoc