Skip to content

TypeScript API / @contentia/vite-plugin / ContentiaTypegenOptions

Interface: ContentiaTypegenOptions ​

Properties ​

channel? ​

ts
readonly channel?: ContentChangeChannel;

Channel to subscribe to for incremental regeneration.


debounceMs? ​

ts
readonly debounceMs?: number;

Debounce window (ms) for coalescing incremental writes. Default 30.


literals? ​

ts
readonly literals?: boolean;

Append as const so literal types are preserved. Default false.


logger? ​

ts
readonly logger?: (message) => void;

Optional diagnostic logger.

Parameters ​

ParameterType
messagestring

Returns ​

void


mdx? ​

ts
readonly mdx?: boolean;

Declare the Body export for items with prose. Mirrors the plugin's mdx option.


namespaces? ​

ts
readonly namespaces?: readonly Namespace[];

Namespaces to enumerate on a full regenerate. Default ['doc', 'store'].


reader? ​

ts
readonly reader?: TypegenReader;

Override the reader (tests / custom hosts). Defaults to backend.ts.


repos? ​

ts
readonly repos?: ContentiaRepositories;

Repositories used when no reader is supplied.


tsLoader? ​

ts
readonly tsLoader?: TypeScriptLoader;

Override typescript loading (tests simulate it being unavailable).


viteRoot ​

ts
readonly viteRoot: string;

Project root Vite serves from; all output is written under here.