Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/builder / Function

entryBuilder

Generic types:T

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.

Presentation

function entryBuilder(config: Config): Builder<EntryMetadata<T>>;

Returns

Builder<EntryMetadata<T>> -

{Builder} - A Builder Observable that emits a NgDocPage object whenever the file at the provided path changes.

Parameters

NameTypeDescription
config
Config

The configuration object for the builder.