Interface: SyncStrategyOptions
Hierarchy​
↳
SyncStrategyOptions
Properties​
blocking​
• Optional blocking: boolean | (...args: any[]) => boolean
Should resolution of the target's sync block the completion of the
source's transform?
By default, blocking is false.
Defined in​
strategies/sync-strategy.ts:40
logLevel​
• Optional logLevel: LogLevel
A specific log level for this strategy.
Overrides the log level used when activating the coordinator.
Inherited from​
Defined in​
logPrefix​
• Optional logPrefix: string
The prefix to use for logging from this strategy.
Defaults to [${name}].
Inherited from​
Defined in​
name​
• Optional name: string
Name of strategy.
Used to uniquely identify this strategy in a coordinator's collection.
Inherited from​
Defined in​
source​
• source: string
The name of the source to be observed.
Defined in​
strategies/sync-strategy.ts:14
sources​
• Optional sources: string[]
The names of sources to include in this strategy. Leave undefined to include all sources registered with a coordinator.
Inherited from​
Defined in​
target​
• target: string
The name of the source which will be acted upon.
Defined in​
strategies/sync-strategy.ts:19
Methods​
catch​
â–¸ Optional catch(error, ...args): void
A handler for any errors thrown as a result of the sync operation.
Parameters​
| Name | Type |
|---|---|
error | Error |
...args | any[] |
Returns​
void
Defined in​
strategies/sync-strategy.ts:24
filter​
â–¸ Optional filter(...args): boolean
A filter function that returns true if the sync should be performed.
filter will be invoked in the context of this strategy (and thus will
have access to both this.source and this.target).
Parameters​
| Name | Type |
|---|---|
...args | any[] |
Returns​
boolean