og-images-generator/types/render.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 RenderedOg
 * @property {string} path
 * @property {Buffer} data
 */
/**
 * @typedef RenderOptions
 * @property {import('satori').SatoriOptions} satori
 * @property {import('@resvg/resvg-js').ResvgRenderOptions} [resvg]
 */
/**
 * @param {import('./generate.js').UserConfig} userConfig
 * @param {import('./collect.js').Page} [page]
 * @returns {Promise<Buffer>}
 */
export function renderOgImage(userConfig: import("./generate.js").UserConfig, page?: import("./collect.js").Page): Promise<Buffer>;
export function fetchFont(fontUrl: string): Promise<ArrayBuffer>;
export namespace OG_SIZE {
    let width: 1200;
    let height: 630;
}
export const SOURCE_SANS_FONT_URL: "https://unpkg.com/typeface-source-sans-pro@1.1.13/files/source-sans-pro-400.woff";
export namespace FONTS {
    function sourceSans(): Promise<{
        name: string;
        data: ArrayBuffer;
    }>;
}
export function renderAllPagesOg(pages: import("./api.js").Page[], config: import("./generate.js").UserConfig): Promise<RenderedOg[]>;
export type RenderedOg = {
    path: string;
    data: Buffer;
};
export type RenderOptions = {
    satori: import("satori").SatoriOptions;
    resvg?: import("@resvg/resvg-js").ResvgRenderOptions;
};
//# sourceMappingURL=render.d.ts.map