types.ts#

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

9 symbols 5 interfaces 3 types 1 modules 1 parameters 28 members 1 returns

Reference#

interfaceOgImageOptionsOG image generation options (user-facing).8 members

OG image generation options (user-facing).

Signature

export interface OgImageOptions

View source

Members

Properties

Name	Type	Description
`cache`optional	`boolean`	Enable content-hash based caching. Skips rendering when content hasn't changed. Default `true`
`concurrency`optional	`number`	Number of concurrent page instances for parallel rendering. Default `1`
`height`optional	`number`	Image height in pixels. Default `630`
`renderer`optional	`OgImageRenderer`	Rendering backend. - `"chromium"`: full browser rendering, best template compatibility - `"satori"`: fast HTML-to-SVG-to-PNG rendering, limited CSS subset Default `"chromium"`
`satori`optional	`OgImageSatoriOptions`	Options for the Satori renderer.
`template`optional	`string`	Path to a custom template file (.ts, .vue, .svelte, .tsx/.jsx). - `.ts`: default-export a function `(props) => string` - `.vue`: Vue SFC, rendered via SSR - `.svelte`: Svelte SFC, rendered via SSR - `.tsx`/`.jsx`: React Server Component, rendered via SSR If not specified, the built-in default template is used.
`vuePlugin`optional	`"vitejs" \| "vizejs"`	Vue plugin to use for compiling `.vue` templates. - `'vitejs'`: Use `@vue/compiler-sfc` (official, default) - `'vizejs'`: Use `@vizejs/vite-plugin` (Rust-based) Default `'vitejs'`
`width`optional	`number`	Image width in pixels. Default `1200`

typeOgImageRenderer = "chromium" | "satori"OG image rendering backend.

OG image rendering backend.

Signature

export type OgImageRenderer = "chromium" | "satori"

View source

interfaceOgImageSatoriFontFont file loaded by the Satori renderer.4 members

Font file loaded by the Satori renderer.

Signature

export interface OgImageSatoriFont

View source

Members

Properties

Name	Type	Description
`name`optional	`string`	Font family name used by template CSS.
`path`	`string`	Absolute path, or a path relative to the project root.
`style`optional	`"normal" \| "italic"`	Font style. Default `"normal"`
`weight`optional	`OgImageSatoriFontWeight`	Font weight. Default `400`

typeOgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900Font weight values supported by Satori.

Font weight values supported by Satori.

Signature

export type OgImageSatoriFontWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

View source

interfaceOgImageSatoriOptionsSatori renderer options.2 members

Satori renderer options.

Signature

export interface OgImageSatoriOptions

View source

Members

Properties

Name	Type	Description
`fonts`optional	`OgImageSatoriFont[]`	Font files passed to Satori. Satori cannot render text without at least one font. When omitted, Ox Content tries a small set of system font paths unless `systemFontFallback` is disabled.
`systemFontFallback`optional	`boolean`	Try known OS font paths when `fonts` is empty. Default `true`

typeOgImageTemplateFn = (props: OgImageTemplateProps) => string | Promise<string>Template function that receives page metadata and returns an HTML string.1 paramreturns string | Promise<string>

Template function that receives page metadata and returns an HTML string.

Signature

export type OgImageTemplateFn = (props: OgImageTemplateProps) => string | Promise<string>

View source

Parameters

props OgImageTemplateProps

Returns

string | Promise<string>

interfaceOgImageTemplatePropsProps passed to OG image template functions.6 members

Props passed to OG image template functions.

Signature

export interface OgImageTemplateProps

View source

Members

Indexable

[key: string]: unknown

Custom data from frontmatter (arbitrary key-value pairs)

Properties

Name	Type	Description
`author`optional	`string`	Author name
`description`optional	`string`	Page description
`siteName`optional	`string`	Site name
`tags`optional	`string[]`	Tags/categories
`title`	`string`	Page title

interfaceResolvedOgImageOptionsResolved OG image options with all defaults applied.8 members

Resolved OG image options with all defaults applied.

Signature

export interface ResolvedOgImageOptions

View source

Members

Properties

Name	Type	Description
`cache`	`boolean`
`concurrency`	`number`
`height`	`number`
`renderer`	`OgImageRenderer`
`satori`	`{ fonts: OgImageSatoriFont[]; systemFontFallback: boolean }`
`template`optional	`string`
`vuePlugin`	`"vitejs" \| "vizejs"`
`width`	`number`

moduletypesType definitions for OG image generation.

Type definitions for OG image generation.

View source