Skip to content

TypeScript API / @laikacms/vite-plugin / TypegenReader

Interface: TypegenReader ​

A minimal reader over a content repository. The typegen only needs to list item keys per namespace and read one item's { content, meta }. In production this is bound to backend.ts (createBackendReader); tests inject an in-memory implementation.

Methods ​

listKeys() ​

ts
listKeys(namespace): Promise<readonly string[]>;

Parameters ​

ParameterType
namespaceNamespace

Returns ​

Promise<readonly string[]>


readItem() ​

ts
readItem(id): Promise<{
  content: Record<string, unknown>;
  meta: Record<string, unknown>;
}>;

Parameters ​

ParameterType
idLaikaId

Returns ​

Promise<{ content: Record<string, unknown>; meta: Record<string, unknown>; }>

Released under the MIT License.