File tree Expand file tree Collapse file tree 1 file changed +24
-1
lines changed
packages/shared/sdk-server/src/api/options Expand file tree Collapse file tree 1 file changed +24
-1
lines changed Original file line number Diff line number Diff line change @@ -157,7 +157,30 @@ export type SynchronizerDataSource =
157157 | StreamingDataSourceConfiguration ;
158158
159159/**
160- * This data source will allow developers to define their own composite data source
160+ * @experimental
161+ * This data source will allow developers to define their own composite data source.
162+ * This is a free-form option and is not subject to any backwards compatibility guarantees or semantic
163+ * versioning.
164+ *
165+ * The following example is roughly equivilent to using the {@link StandardDataSourceOptions} with the default values.
166+ * @example
167+ * ```typescript
168+ * dataSource: {
169+ * dataSourceOptionsType: 'custom',
170+ * initializers: [
171+ * {
172+ * type: 'polling'
173+ * },
174+ * ],
175+ * synchronizers: [
176+ * {
177+ * type: 'streaming',
178+ * },
179+ * {
180+ * type: 'polling',
181+ * }
182+ * ],
183+ * }
161184 */
162185export interface CustomDataSourceOptions {
163186 dataSourceOptionsType : 'custom' ;
You can’t perform that action at this time.
0 commit comments