og-images-generator/types/generate.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 UserConfig
 * @property {import('./render.js').RenderOptions} renderOptions
 * @property {import('./api.js').Template} template
 */
/**
 * @param {string} [path]
 * @returns {Promise<UserConfig>}
 */
export function loadUserConfig(path?: string): Promise<UserConfig>;
/**
 *
 * @param {import('./render.js').RenderedOg[]} renderedImages
 * @param {string} out
 */
export function save(renderedImages: import("./render.js").RenderedOg[], out: string): Promise<void>;
/**
 * @param {import("./collect").PathsOptions} [options]
 * @return {Promise<void>}
 * */
export function generateOgImages(options?: import("./collect").PathsOptions): Promise<void>;
export const CONFIG_FILE_NAME: "og-images.config.js";
export const CONFIG_FILE_PATH: string;
export type UserConfig = {
    renderOptions: import("./render.js").RenderOptions;
    template: import("./api.js").Template;
};
//# sourceMappingURL=generate.d.ts.map