Interface ISyncApi

Interface used with historical sync'ing to start model sync on one or more models, or to shutdown the service providing the sync'ing

Hierarchy

ISyncQueryApi
- ISyncApi

Implemented by

SyncApi

Index

Properties

Methods

shutdown startModelSync stopModelSync syncComplete

Properties

enabled

enabled: boolean

Methods

shutdown

shutdown(): Promise<void>
Returns Promise<void>
- Defined in packages/indexing/src/history-sync/interfaces.ts:37

startModelSync

startModelSync(models: string | string[], modelSyncOptions?: ModelSyncOptions): Promise<void>
Parameters
- models: string | string[]
- Optional modelSyncOptions: ModelSyncOptions
Returns Promise<void>
- Defined in packages/indexing/src/history-sync/interfaces.ts:35

stopModelSync

stopModelSync(models: string | string[]): Promise<void>
Parameters
- models: string | string[]
Returns Promise<void>
- Defined in packages/indexing/src/history-sync/interfaces.ts:36

syncComplete

syncComplete(model: string): boolean
Parameters
- model: string
Returns boolean
Inherited from ISyncQueryApi.syncComplete
- Defined in packages/indexing/src/history-sync/interfaces.ts:17