og-images-generator/types/collect.d.ts

Generate OG images from a static folder and / or a middleware. Extract metadata from HTML pages. No headless browser involved. Comes as a CLI, API or plugins.

/**
 * @typedef {Record<string, string>} MetaTags
 * @typedef {Record<string, any>[]} JsonLds
 *
 * @typedef Metadata
 * @property {MetaTags} [tags]
 * @property {JsonLds} [jsonLds]
 *
 * @typedef Page
 * @property {Metadata} [meta]
 * @property {string} path
 */
/**
 * @param {string} fileContent
 * @returns {Metadata}
 */
export function extractMetadataFromHtml(fileContent: string): Metadata;
/**
 * @typedef PathsOptions
 * @property {string} [base]
 * @property {string} [out]
 * @property {string} [json]
 * @property {string[]} [additionalPatterns]
 * @property {import('fast-glob').Options} [globber]
 *
 * @typedef {Required<PathsOptions>} CollectOptions
 */
/**
 * @param {CollectOptions} options
 * @returns {Promise<Page[]>}
 * */
export function collectHtmlPages(options: CollectOptions): Promise<Page[]>;
export type MetaTags = Record<string, string>;
export type JsonLds = Record<string, any>[];
export type Metadata = {
    tags?: MetaTags;
    jsonLds?: JsonLds;
};
export type Page = {
    meta?: Metadata;
    path: string;
};
export type PathsOptions = {
    base?: string;
    out?: string;
    json?: string;
    additionalPatterns?: string[];
    globber?: import("fast-glob").Options;
};
export type CollectOptions = Required<PathsOptions>;
//# sourceMappingURL=collect.d.ts.map