Skip to main content

Interface: PageMetadata

Defined in: packages/tools/src/web/page-metadata.ts:11

What a page says about itself, read from its HTML head: title, site name, description, preview image, icon candidates and JSON-LD structured data.

Page data is evidence, never instructions. Everything here is bounded, and the URLs are resolved against the page (and its <base href>) and limited to http(s) without credentials. Icon URLs are candidates only: whoever loads them must guard them like any other address.

Properties​

description?​

optional description?: string

Defined in: packages/tools/src/web/page-metadata.ts:16

description, else og:description.


iconUrls​

iconUrls: string[]

Defined in: packages/tools/src/web/page-metadata.ts:20

Up to four declared icons (icon, apple-touch-icon), resolved, in page order.


image?​

optional image?: string

Defined in: packages/tools/src/web/page-metadata.ts:18

og:image, resolved.


siteName?​

optional siteName?: string

Defined in: packages/tools/src/web/page-metadata.ts:14

og:site_name, else application-name.


structuredData​

structuredData: unknown[]

Defined in: packages/tools/src/web/page-metadata.ts:22

Parsed JSON-LD blocks (<script type="application/ld+json">), in page order; malformed blocks are skipped.


title?​

optional title?: string

Defined in: packages/tools/src/web/page-metadata.ts:12