ChainRoute
Exports of one matched route that the metadata API reads.
Exports of one matched route that the metadata API reads.
Import#
ts
import type { ChainRoute } from "@shadow-js/dusk/server";
Signature#
ts
interface ChainRoute {
readonly id: string;
readonly params: Readonly<Record<string, string>>;
readonly loaderData: unknown;
readonly metadata?: Metadata | undefined;
readonly generateMetadata?:
| ((args: MetadataArgs) => Metadata | PromiseLike<Metadata>)
| undefined;
/**
* Adds the static `opengraph-image` and `twitter-image` files this route carries (the build sets it on the first
* route of each chain inside the folder that holds them). Runs on the merged result of the route's own layer; see
* `file-images.ts`.
*/
readonly fileImages?: FileImagesHook | undefined;
readonly viewport?: Viewport | undefined;
readonly generateViewport?:
| ((args: MetadataArgs) => Viewport | PromiseLike<Viewport>)
| undefined;
readonly links?:
| (
| readonly LinkDescriptor[]
| ((args: MetaArgs) => readonly LinkDescriptor[] | PromiseLike<readonly LinkDescriptor[]>)
)
| undefined;
readonly meta?:
| (
| readonly MetaDescriptor[]
| ((args: MetaArgs) => readonly MetaDescriptor[] | PromiseLike<readonly MetaDescriptor[]>)
)
| undefined;
readonly headers?:
| (
| Readonly<Record<string, string>>
| ((
args: HeadersArgs,
) => Readonly<Record<string, string>> | PromiseLike<Readonly<Record<string, string>>>)
)
| undefined;
}
Members#
| Name | Type | Description |
|---|---|---|
id |
readonly id: string |
|
params |
readonly params: Readonly<Record<string, string>> |
|
loaderData |
readonly loaderData: unknown |
|
metadata? |
readonly metadata?: Metadata | undefined |
|
generateMetadata? |
readonly generateMetadata?: | ((args: MetadataArgs) => Metadata | PromiseLike<Metadata>) | undefined |
|
fileImages? |
readonly fileImages?: FileImagesHook | undefined |
Adds the static opengraph-image and twitter-image files this route carries (the build sets it on the first route of each chain inside the folder that holds them). Runs on the merged result of the route's own layer; see file-images.ts. |
viewport? |
readonly viewport?: Viewport | undefined |
|
generateViewport? |
readonly generateViewport?: | ((args: MetadataArgs) => Viewport | PromiseLike<Viewport>) | undefined |
|
links? |
readonly links?: | ( | readonly LinkDescriptor[] | ((args: MetaArgs) => readonly LinkDescriptor[] | PromiseLike<readonly LinkDescriptor[]>) ) | undefined |
|
meta? |
readonly meta?: | ( | readonly MetaDescriptor[] | ((args: MetaArgs) => readonly MetaDescriptor[] | PromiseLike<readonly MetaDescriptor[]>) ) | undefined |
|
headers? |
readonly headers?: | ( | Readonly<Record<string, string>> | (( args: HeadersArgs, ) => Readonly<Record<string, string>> | PromiseLike<Readonly<Record<string, string>>>) ) | undefined |