TypeScript API / @laikacms/vite-plugin / LaikaTypegen
Class: LaikaTypegen
Stateful typegen engine. Holds the per-item declaration blocks in memory and (re)writes the aggregate .laika/vite-generated/types.d.ts plus per-collection union aliases. Safe to use one-shot (build / cold dev, no channel) or incrementally (dev, driven by a ContentChangeChannel).
Constructors
Constructor
new LaikaTypegen(options): LaikaTypegen;Parameters
| Parameter | Type |
|---|---|
options | LaikaTypegenOptions |
Returns
LaikaTypegen
Methods
dispose()
dispose(): Promise<void>;Stop listening to the channel and write any pending changes.
Returns
Promise<void>
flush()
flush(): Promise<void>;Force an immediate write of all outputs.
Returns
Promise<void>
ingest()
ingest(
id,
content,
meta
): Promise<void>;Ingest one item's concrete { content, meta } (e.g. from a Vite load hook). Computes its declaration block and schedules a debounced write.
Parameters
| Parameter | Type |
|---|---|
id | string | LaikaId |
content | Record<string, unknown> |
meta | Record<string, unknown> |
Returns
Promise<void>
regenerateAll()
regenerateAll(repos?): Promise<void>;Full rebuild: enumerate every item in every namespace via the reader and regenerate all blocks, then flush synchronously. Works with no channel (build + cold dev).
Parameters
| Parameter | Type |
|---|---|
repos? | LaikaRepositories |
Returns
Promise<void>
regenerateItem()
regenerateItem(id, repos?): Promise<void>;Read one item via the reader and ingest it.
Parameters
| Parameter | Type |
|---|---|
id | string | LaikaId |
repos? | LaikaRepositories |
Returns
Promise<void>
remove()
remove(id): Promise<void>;Drop an item's types and schedule a write.
Parameters
| Parameter | Type |
|---|---|
id | string | LaikaId |
Returns
Promise<void>