Interface: LoadResult

View as Markdown

Defined in: index.ts:176

What load returns.

Example

const pages: Loader = {
  load: () => ({
    entries: [{ slug: "hello" }],
    warnings: ["pages: the API is unreachable, so these pages come from the cache"],
  }),
};

Properties

entries

entries: readonly Entry<TFile>[];

Defined in: index.ts:180

In the order documents() returns them.

issues?

issues?: readonly LoadIssue[];

Defined in: index.ts:182

Entries that could not be loaded. The rest still load.

warnings?

warnings?: readonly string[];

Defined in: index.ts:184

Printed as they are. Say what happens because of them, eg directory "x" has no files, so the collection is empty.