Skip to content

TypeScript API / @laikacms/astro / LaikaIntegrationOptions

Interface: LaikaIntegrationOptions ​

Extends ​

Properties ​

api? ​

ts
optional api?: boolean | LaikaApiOptions;

Mount the unauthenticated JSON:API on the dev server, so the Decap admin reads and writes your content locally. true (default) uses the defaults in LaikaApiOptions. Never mounted in a build.


catalog? ​

ts
optional catalog?: CatalogChoice;

Which catalog maps a collection to a directory. Defaults to 'convention'. Ignored when repositories is given.

Inherited from ​

LaikaRepositoryOptions.catalog


configKey? ​

ts
optional configKey?: string;

Where the Decap config lives, for catalog: 'decap'. Defaults to 'config'.

Inherited from ​

LaikaRepositoryOptions.configKey


defaultExtension? ​

ts
optional defaultExtension?: string;

File extension applied to keys without one. Defaults to 'json'.

Inherited from ​

LaikaRepositoryOptions.defaultExtension


dir? ​

ts
optional dir?: string;

Directory the default filesystem repository reads, resolved relative to the Astro project root. Ignored when storage or repositories is given. Defaults to 'content'.

Inherited from ​

LaikaRepositoryOptions.dir


refresh? ​

ts
optional refresh?: boolean | LaikaRefreshOptions;

Refresh content when the repository changes. true (default) enables it.


repositories? ​

ts
optional repositories?: any;

Bring your own repositories. Highest precedence — nothing else in this struct is read when it is set.

Inherited from ​

LaikaRepositoryOptions.repositories


serializers? ​

ts
optional serializers?: StorageSerializerRegistry;

Serializer registry for the default filesystem repository.

Inherited from ​

LaikaRepositoryOptions.serializers


storage? ​

ts
optional storage?: StorageRepository;

Provide only the storage repository; the documents and assets repositories are derived from it via Catalog. Ignored when repositories is given.

Inherited from ​

LaikaRepositoryOptions.storage


types? ​

ts
optional types?: boolean;

Emit .astro/integrations/@laikacms-astro/types.d.ts. Defaults to true.

Released under the MIT License.