import { Table } from '@elaraai/core/data'; import { ELARASchema } from '@elaraai/core/schema'; /** * A {@link TablesPluginDefinition} to configure the {@link TablesPlugin}. * * @category Data */ export declare type TablesPluginDefinition = { /** the `Record` containing one or more {@link Table}'s */ tables: Record | Table[]; /** prepend the artefact names with this */ prepend?: string; icon?: string; }; /** * Create a diagnostic page showing a the values within one ore more {@link Table}'s * * @param definition: the desired {@link TablesPluginDefinition}. * @return a {@link ELARASchema} containing a {@link TablesPluginDefinition} contents * * @category Data * * @example * ```typescript * // use a data source * import csv from "./gen/csv.source" * import json from "./gen/json.source" * // Create a `TablesPlugin` to generate two pages with output of the `DataSource`'s. * const tables = TablesPlugin({ * tables: { * csv: csv.output, * json: json.output * } * }) * ``` */ export declare function TablesPlugin(config: TablesPluginDefinition): ELARASchema; //# sourceMappingURL=tables.d.ts.map