import { DataSource } from '@elaraai/core/datasource'; import { ELARASchema } from '@elaraai/core/schema'; /** * A {@link DataSourcePluginDefinition} to configure the {@link DataSourcePlugin}. * * @category DataSource */ export declare type DataSourcePluginDefinition = { /** the `Record` or `Array` containing one or more {@link DataSource}'s */ datasources: Record | DataSource[]; /** prepend the artefact names with this */ prepend?: string; }; /** * Utility plugin to simplify creating diagnostic content for `DataSource`'s. * * @param definition: the desired {@link DataSourcePluginDefinition}. * @return a {@link ELARASchema} containing a {@link DataSourcePluginDefinition} contents * * @category DataSource * * @example * ```typescript * // get the datasource to add to the plugin * import datasource_one from './gen/datasource_one.datasource' * import datasource_two from './gen/datasource_two.datasource' * // Create diagnostic content for multiple datasources with a `Record` * const plugin = DataSourcePlugin({ * datasources: { * One: datasource_one, * Two: datasource_two * } * }) * ``` * Or using arrays: * @example * ```typescript * // get the datasource to add to the plugin * import datasource_one from './gen/datasource_one.datasource' * import datasource_two from './gen/datasource_two.datasource' * // Create diagnostic content for multiple datasources with an `Array` * const plugin = DataSourcePlugin({ * datasources: [datasource_one, datasource_two] * }) * ``` */ export declare function DataSourcePlugin(config: DataSourcePluginDefinition): ELARASchema; //# sourceMappingURL=datasource.d.ts.map