Skip to content

TypeScript API / @contentia/astro/live / ContentiaEntryFilter

Interface: ContentiaEntryFilter ​

Identifies one document. Supply either the Astro entry id or the full Contentia key.

Properties ​

id? ​

ts
id?: string;

The Astro entry id — the Contentia key with the collection prefix removed. getLiveEntry(collection, 'some-id') is normalised to this field, so it is the one that makes the string shorthand work.


key? ​

ts
key?: string;

The full Contentia key. Takes precedence over id.


status? ​

ts
status?: string;

Which unpublished status to read. Only meaningful with type: 'unpublished'.


type? ​

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

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