ArdoPage

Auf dieser Seite

Diese API-Referenz wird aus den englischen TypeScript-Quellkommentaren erzeugt. Namen, Signaturen und Beispiele entsprechen dem veröffentlichten Paket.

What Ardo knows about the page it renders.

import type { ArdoPage } from "ardo/runtime"

type ArdoPage = {
    /** Public base path of the site, with leading and trailing slash. */
    base: string;
    /** Page component, or the error component when `error` is set. */
    component?: ComponentType;
    /** Error that replaced the page content. */
    error?: ArdoPageError;
    /** The route module's `handle` export. */
    handle?: unknown;
    /** Path of the page without the base path, starting with a slash. */
    path: string;
    /** Source identity and modification time supplied by the route table. */
    source?: {
        relativePath: string;
        lastUpdated: number;
    };
};

Properties

Name	Type	Required	Description
`base`	`string`	Yes	Public base path of the site, with leading and trailing slash.
`component`	`ComponentType`	No	Page component, or the error component when `error` is set.
`error`	`ArdoPageError`	No	Error that replaced the page content.
`handle`	`unknown`	No	The route module's `handle` export.
`path`	`string`	Yes	Path of the page without the base path, starting with a slash.
`source`	`{ relativePath: string; lastUpdated: number }`	No	Source identity and modification time supplied by the route table.