Skip to content

TypeScript API / @contentia/astro/loader / ObjectsLoaderOptions

Interface: ObjectsLoaderOptions ​

Extends ​

Properties ​

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


entry? ​

ts
entry?: EntryOptions;

name? ​

ts
name?: string;

Loader name, which is what refreshContent({ loaders }) targets.


render? ​

ts
render?: RenderOptions;

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


root? ​

ts
root?: string;

Astro project root, for resolving a relative dir before load runs.


select? ​

ts
select?: ObjectSelectOptions;

serializers? ​

ts
serializers?: StorageSerializerRegistry;

Serializer registry for the default filesystem repository.

Inherited from ​

ContentiaRepositoryOptions.serializers


storage? ​

ts
storage?: StorageRepository;

The storage repository to read. Highest precedence.

Overrides ​

ContentiaRepositoryOptions.storage


sync? ​

ts
sync?: ObjectsSyncOptions;

z? ​

ts
z?: ZodNamespace;

The z from astro:content.

Storage objects have no catalog fields to derive a schema from, so supplying z — together with an explicit select.folder — makes the loader describe the objects it actually finds and hand Astro the resulting types. entry.data is then typed instead of unknown.

The schema stays permissive: these types report what the content contains, they do not constrain what it may contain.