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

import type { Options as GlobOptions } from 'fast-glob';
export type MetaTags = Record<string, string>;
export type JsonLds = Record<string, unknown>[];
export interface Metadata {
    tags?: MetaTags;
    jsonLds?: JsonLds;
}
export interface Page {
    meta?: Metadata;
    path: string;
}
export interface PathsOptions {
    base?: string;
    out?: string;
    json?: string;
    additionalPatterns?: string[];
    globber?: GlobOptions;
}
export type CollectOptions = Required<PathsOptions>;
export declare function extractMetadataFromHtml(fileContent: string): Metadata;
export declare function collectHtmlPages(options: CollectOptions): Promise<Page[]>;
//# sourceMappingURL=collect.d.ts.map