import { Page } from '@elaraai/core/page'; import { ELARASchema } from '@elaraai/core/schema'; /** * A {@link PagePluginDefinition} to configure the {@link PagePlugin}. * * @category Application */ export declare type PagePluginDefinition = { /** the `Record` containing one or more {@link Page}'s */ pages: Record | Page[]; /** prepend the artefact names with this */ prepend?: string; /** true if information about operations be included */ operations?: boolean; }; /** * Utility plugin to simplify injecting one or more pages into a {@link ELARASchema}. * * @param definition: the desired {@link PagePluginDefinition}. * @return a {@link ELARASchema} containing a {@link PagePluginDefinition} contents * * @category Application * * @example * ```typescript * // get the page to add to the plugin * import page_one from './gen/page_one.page' * import page_two from './gen/page_two.page' * // Create diagnostic content for multiple pages. * const plugin = PagePlugin({ * pages: { * One: page_one, * Two: page_two * } * }) * ``` */ export declare function PagePlugin(config: PagePluginDefinition): ELARASchema; //# sourceMappingURL=page.d.ts.map