Skip to content

TypeScript API / @laikacms/astro / LaikaApiOptions

Interface: LaikaApiOptions ​

Properties ​

access? ​

ts
optional access?: ApiAccess;

What the injected route exposes. Defaults to 'published' — the content a static build already ships, and nothing else. Ignored in 'dev' mode, which is always read-write and local-only.


basePath? ​

ts
optional basePath?: string;

Where the JSON:API is mounted. Defaults to /__laika.


mode? ​

ts
optional mode?: "dev" | "route";

'dev' (default) serves the API from the dev server only, read-write, for the CMS admin. It does not exist in a build.

'route' additionally injects a real Astro route that survives into a deployment. The route is rendered on demand, so the project needs an adapter and output: 'server'.

Released under the MIT License.