collectOgpUrls(html: string): Promise<string[]>Collect all OGP URLs from HTML for pre-fetching.Collect all OGP URLs from HTML for pre-fetching.
export async function collectOgpUrls(html: string): Promise<string[]>html
string
Promise<string[]>
createFallbackCard(url: string): ElementCreate fallback element when OGP data is unavailable.Create fallback element when OGP data is unavailable.
function createFallbackCard(url: string): Elementurl
string
Element
createOgpCard(data: OgpData): ElementCreate OGP card element.Create OGP card element.
function createOgpCard(data: OgpData): Elementdata
OgpData
Element
extractDomain(url: string): stringExtract domain from URL.Extract domain from URL.
function extractDomain(url: string): stringurl
string
string
fetchOgpData(url: string, options: Required<OgpOptions>): Promise<OgpData | null>Fetch OGP data for a URL.Fetch OGP data for a URL.
export async function fetchOgpData(url: string, options: Required<OgpOptions>): Promise<OgpData | null>url
string
options
Required<OgpOptions>
Promise<OgpData | null>
getAttribute(el: Element, name: string): string | undefinedGet element attribute value.Get element attribute value.
function getAttribute(el: Element, name: string): string | undefinedel
Element
name
string
string | undefined
getFaviconUrl(url: string): stringGet favicon URL for a domain.Get favicon URL for a domain.
function getFaviconUrl(url: string): stringurl
string
string
ogpOGP Card Plugin - Link card embedding Transforms <OgCard> components into static link preview cards by fetching OGP met…OGP Card Plugin - Link card embedding
Transforms <OgCard> components into static link preview cards by fetching OGP metadata at build time.
parseOgpFromHtml(html: string, url: string): OgpDataParse OGP metadata from HTML.Parse OGP metadata from HTML.
function parseOgpFromHtml(html: string, url: string): OgpDatahtml
string
url
string
OgpData
prefetchOgpData(urls: string[], options?: OgpOptions): Promise<Map<string, OgpData | null>>Pre-fetch all OGP data.Pre-fetch all OGP data.
export async function prefetchOgpData(urls: string[], options?: OgpOptions): Promise<Map<string, OgpData | null>>urls
string[]
options
OgpOptions
optional
Promise<Map<string, OgpData | null>>
rehypeOgp(ogpDataMap: Map<string, OgpData | null>)Rehype plugin to transform OgCard components.Rehype plugin to transform OgCard components.
function rehypeOgp(ogpDataMap: Map<string, OgpData | null>)ogpDataMap
Map<string, OgpData | null>
transformOgp(html: string, ogpDataMap?: Map<string, OgpData | null>, options?: OgpOptions): Promise<string>Transform OgCard components in HTML.Transform OgCard components in HTML.
export async function transformOgp(html: string, ogpDataMap?: Map<string, OgpData | null>, options?: OgpOptions): Promise<string>html
string
ogpDataMap
Map<string, OgpData | null>
optional
options
OgpOptions
optional
Promise<string>