og-images-generator/dist/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.

import type { SatoriOptions } from 'satori';
import type { ResvgRenderOptions } from '@resvg/resvg-js';
import type { UserConfig } from './generate.js';
import type { Page } from './collect.js';
export declare const fetchFont: (fontUrl: string) => Promise<ArrayBuffer>;
export declare const OG_SIZE: {
    readonly width: 1200;
    readonly height: 630;
};
export declare const SOURCE_SANS_FONT_URL = "https://unpkg.com/typeface-source-sans-pro@1.1.13/files/source-sans-pro-400.woff";
export declare const FONTS: {
    readonly sourceSans: () => Promise<{
        name: string;
        data: ArrayBuffer;
    }>;
};
export interface RenderedOg {
    path: string;
    data: Buffer;
}
export interface RenderOptions {
    satori: SatoriOptions;
    resvg?: ResvgRenderOptions;
}
export declare function renderOgImage(userConfig: UserConfig, page?: Page): Promise<Buffer>;
export declare const renderAllPagesOg: (pages: Page[], config: UserConfig) => Promise<RenderedOg[]>;
//# sourceMappingURL=render.d.ts.map