This is the dev preview website. Check out the document at lynxjs.org

Home > @lynx-js/genui > writeCatalogArtifacts

writeCatalogArtifacts() function

Bootstrap TypeDoc once and emit both component and function catalog files. Preferred entry point for the CLI — running the conversion twice doubles cold-start latency on large catalogs.

Signature:

export declare function writeCatalogArtifacts(options: WriteComponentCatalogOptions): Promise<CatalogArtifacts>;

Parameters

Parameter

Type

Description

options

WriteComponentCatalogOptions

Returns:

Promise<CatalogArtifacts>