page-head.ts#

3 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

3 symbols 1 functions 1 interfaces 1 types 1 parameters 18 members 1 returns

Reference#

interfaceHeadInputBuild-time page-head input. Unhead-shaped, no client runtime. Unknown keys such…18 members

Build-time page-head input. Unhead-shaped, no client runtime.

Unknown keys such as twitter.imggg are a TypeScript error here. Use metas / links for extra tags.

export interface HeadInput

Name	Type	Description
`alternates`optional	`HeadAlternate[]`
`canonical`optional	`string`
`description`optional	`string`
`emitSiteName`optional	`boolean`
`jsonLd`optional	`HeadJsonLd[]`
`links`optional	`HeadLink[]`
`metas`optional	`HeadMeta[]`
`ogImage`optional	`string`
`ogType`optional	`string`
`robots`optional	`string`
`site`optional	`SiteHead`
`social`optional	`boolean`
`title`optional	`string`
`titleSuffix`optional	`boolean`
`titleTemplate`optional	`string`
`trusted`optional	`boolean`
`twitterCard`optional	`"summary" \| "summary_large_image" \| (string & {})`
`validation`optional	`"off" \| "warn" \| "strict"`

typeHeadValidationMode = false | "off" | "warn" | "strict"How invalid head descriptors are reported.

How invalid head descriptors are reported.

export type HeadValidationMode = false | "off" | "warn" | "strict"

fnrenderHead(input: HeadInput): RenderedHeadResolve descriptors to escaped <head> markup. Build-time only.1 paramreturns RenderedHead

Resolve descriptors to escaped <head> markup. Build-time only.

export function renderHead(input: HeadInput): RenderedHead

RenderedHead