TypeScript API / @laikacms/astro/live / LaikaEntryFilter

Interface: LaikaEntryFilter

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

Properties

id?

optional id?: string;

The Astro entry id — the Laika 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?

optional key?: string;

The full Laika key. Takes precedence over id.

---

status?

optional status?: string;

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

---

type?

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

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