Skip to content

TypeScript API / @contentia/astro / ContentiaIntegrationOptions

Interface: ContentiaIntegrationOptions ​

Extends ​

Properties ​

api? ​

ts
api?: boolean | ContentiaApiOptions;

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 ContentiaApiOptions. Never mounted in a build.


catalog? ​

ts
catalog?: CatalogChoice;

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

Inherited from ​

ContentiaRepositoryOptions.catalog


configKey? ​

ts
configKey?: string;

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

Inherited from ​

ContentiaRepositoryOptions.configKey


defaultExtension? ​

ts
defaultExtension?: string;

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

Inherited from ​

ContentiaRepositoryOptions.defaultExtension


dir? ​

ts
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 ​

ContentiaRepositoryOptions.dir


refresh? ​

ts
refresh?: boolean | ContentiaRefreshOptions;

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


repositories? ​

ts
repositories?: any;

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

Inherited from ​

ContentiaRepositoryOptions.repositories


serializers? ​

ts
serializers?: StorageSerializerRegistry;

Serializer registry for the default filesystem repository.

Inherited from ​

ContentiaRepositoryOptions.serializers


storage? ​

ts
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 ​

ContentiaRepositoryOptions.storage


types? ​

ts
types?: boolean;

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