Skip to content

TypeScript API / @contentia/astro/loader / DocumentSelectOptions

Interface: DocumentSelectOptions ​

Properties ​

depth? ​

ts
depth?: number;

How many levels below the folder to descend. Defaults to 64 — effectively "all".


folder? ​

ts
folder?: string;

A sub-folder inside the collection. Omit to read the whole collection.


language? ​

ts
language?: string;

Keep only documents in this language.


pagination? ​

ts
pagination?: LoaderPagination;

Page size used while draining the listing. Defaults to { perPage: 1000 }.


statuses? ​

ts
statuses?: string[];

Restrict to these unpublished statuses. Only meaningful with type: 'unpublished'.


type? ​

ts
type?: "published" | "unpublished";

Which publication state to read. Defaults to 'published'.