UNPKG

@ng-doc/builder

Version:

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/ng-doc/ng-doc"> <img src="https://ng-doc.com/assets/images/ng-doc.svg?raw=true" alt="Logo" height="150px"> </a>

21 lines (20 loc) 1.03 kB
import { NgDocApi, NgDocPage } from '@ng-doc/core'; import { NgDocBuilderContext } from '../../../interfaces'; import { Builder } from '../../core'; import { EntryMetadata } from '../interfaces'; interface Config { tag: string; context: NgDocBuilderContext; entryPath: string; } /** * A builder function for a entry file. * * This function returns a Builder Observable that emits a NgDocPage object whenever the file at the provided path changes. * The Builder Observable is created by merging an Observable that emits on file changes. * When the file changes, the build function is called, which compiles the TypeScript file, imports it as an ES module, and returns the default export. * @returns {Builder<NgDocPage>} - A Builder Observable that emits a NgDocPage object whenever the file at the provided path changes. * @param config - The configuration object for the builder. */ export declare function entryBuilder<T extends NgDocPage | NgDocApi>(config: Config): Builder<EntryMetadata<T>>; export {};