Interface CustomDataSourceOptionsExperimental

This data source will allow developers to define their own composite data source. This is a free-form option and is not subject to any backwards compatibility guarantees or semantic versioning.

The following example is roughly equivilent to using the StandardDataSourceOptions with the default values.

Example

dataSource: {
dataSourceOptionsType: 'custom',
initializers: [
{
type: 'polling'
},
],
synchronizers: [
{
type: 'streaming',
},
{
type: 'polling',
}
],
}

Hierarchy

  • CustomDataSourceOptions

Properties

dataSourceOptionsType: "custom"
initializers: InitializerDataSource[]

Ordered list of InitializerDataSource that will run in order. The first initializer that successfully returns a valid payload will transition the sdk out of intialization stage into the synchronization stage.

synchronizers: SynchronizerDataSource[]

Order list of SynchronizerDataSource in priority order. Datasources will failover to the next datasource in this array until there are no datasources left to run.

Generated using TypeDoc