TypeScript API / @laikacms/astro/loader / LaikaCollectionsOptions
Interface: LaikaCollectionsOptions
Extends
Properties
allowEmpty?
optional allowEmpty?: boolean;Return {} instead of throwing when the catalog enumerates nothing. Off by default: an empty collections export is almost always a misconfiguration, and failing loudly beats a site that silently has no content.
catalog?
optional catalog?: CatalogChoice;Which catalog maps a collection to a directory. Defaults to 'convention'. Ignored when repositories is given.
Inherited from
LaikaRepositoryOptions.catalog
configKey?
optional configKey?: string;Where the Decap config lives, for catalog: 'decap'. Defaults to 'config'.
Inherited from
LaikaRepositoryOptions.configKey
defaultExtension?
optional defaultExtension?: string;File extension applied to keys without one. Defaults to 'json'.
Inherited from
LaikaRepositoryOptions.defaultExtension
dir?
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
exclude?
optional exclude?: string[];Skip these collections.
include?
optional include?: string[];Only these collections. Defaults to every document collection in the catalog.
overrides?
optional overrides?: Record<string, CollectionOverride>;Per-collection overrides.
render?
optional render?: RenderOptions;Applied to every collection; a per-collection override wins.
repositories?
optional repositories?: any;Bring your own repositories. Highest precedence — nothing else in this struct is read when it is set.
Inherited from
LaikaRepositoryOptions.repositories
root?
optional root?: string;Astro project root, for resolving a relative dir. Defaults to process.cwd().
serializers?
optional serializers?: StorageSerializerRegistry;Serializer registry for the default filesystem repository.
Inherited from
LaikaRepositoryOptions.serializers
storage?
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
z?
optional z?: ZodNamespace;The z from astro:content. Supply it to derive a schema per collection from the catalog's fields. Omit it and collections are created without a schema — content still loads, it is just not validated.