og-images-generator
Version:
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.
17 lines • 832 B
TypeScript
import type { ServerRenderedTemplate } from '@lit-labs/ssr';
import type { Page, PathsOptions } from './collect.js';
import type { RenderedOg, RenderOptions } from './render.js';
export declare const CONFIG_FILE_NAME = "og-images.config.js";
export declare const CONFIG_FILE_PATH: string;
export interface TemplateOptions {
page: Page;
}
export type Template = (options: TemplateOptions) => ServerRenderedTemplate | Promise<ServerRenderedTemplate>;
export interface UserConfig {
renderOptions: RenderOptions;
template: Template;
}
export declare function loadUserConfig(configPath?: string): Promise<UserConfig>;
export declare function save(renderedImages: RenderedOg[], out: string): Promise<void>;
export declare function generateOgImages(options?: PathsOptions): Promise<void>;
//# sourceMappingURL=generate.d.ts.map