MetadataArgs

Arguments of generateMetadata and generateViewport.

Import#

import type { MetadataArgs } from "@shadow-js/dusk";

Signature#

interface MetadataArgs<P = Readonly<Record<string, string>>, L = unknown> {
  /** Route params of this layer. */
  readonly params: P;
  /** The raw query string as a record (not the validated search). A repeated key is an array. */
  readonly search: Readonly<Record<string, string | readonly string[]>>;
  /** The metadata resolved so far (the layers above this one). */
  readonly parent: Metadata;
  /** The loader data of this layer, when the route has a loader. */
  readonly loaderData: L | undefined;
}

Members#

Name	Type	Description
`P`	`P = Readonly<Record<string, string>>`
`L`	`L = unknown`
`params`	`readonly params: P`	Route params of this layer.
`search`	`readonly search: Readonly<Record<string, string \| readonly string[]>>`	The raw query string as a record (not the validated search). A repeated key is an array.
`parent`	`readonly parent: Metadata`	The metadata resolved so far (the layers above this one).
`loaderData`	`readonly loaderData: L \| undefined`	The loader data of this layer, when the route has a loader.