Metadata

Metadata: object

Represents metadata for a webpage

Type declaration

author?

optional author: string

Author of the webpage

Example

<meta name="author" content="John Doe" />

authorWebsite?

optional authorWebsite: string

URL of the author of the website

Example

<link rel="author" href="https://johndoe.com" />

canonicalUrl?

optional canonicalUrl: string

Canonical URL of the webpage

Default

The current url without the query params

Example

<link rel="canonical" href="https://example.com/your-page" />

charset?

optional charset: string

Character set of the webpage

Default

UTF-8

Example

<meta charset="UTF-8" />

description?

optional description: string

A short description of the webpage content

Example

<meta name="description" content="Your website description" />

follow?

optional follow: boolean

Whether the webpage should be followed by search engines

Default

true

Example

<meta name="robots" content="follow" />

index?

optional index: boolean

Whether the webpage should be indexed by search engines

Default

true

Example

<meta name="robots" content="index" />

keywords?

optional keywords: string[]

Keywords associated with the webpage

Example

<meta name="keywords" content="keyword1, keyword2, keyword3" />

openGraph?

optional openGraph: OpenGraphMeta

Open Graph metadata for the webpage

sitemapUrl?

optional sitemapUrl: string

URL to the sitemap

Default

/sitemap.xml

Example

<link rel="sitemap" type="application/xml" title="Sitemap" href="/sitemap.xml" />

title

title: string

The title of the webpage

Example

<title>Your webpage title</title>

twitter?

optional twitter: TwitterCard

Twitter card metadata for the webpage