Interface: Entry

Defined in: index.ts:80

One document as a loader returns it, before the schema and transform.

Example

const hello: Entry = { body: "# Hello", metadata: { title: "Hello" }, slug: "hello" };

Properties

body?

body?: string;

Defined in: index.ts:86

Becomes the document's body, eg a file's text after the frontmatter.

Default: ""

file?

file?: TFile;

Defined in: index.ts:88

Where the entry's file lives, when it has one.

metadata?

metadata?: object;

Defined in: index.ts:94

Validated by the collection's schema next.

Default: {}

slug

slug: string;

Defined in: index.ts:96

The document's key in its collection, eg guides/setup. A non-empty string, unique in the collection.