staticsitegenerators/edition-types/util.d.ts

A comprehensive, partially automatically generated comparison of static site generators with some minimal meta data about them

import { RawEntry, HydratedEntry } from './types.js';
export interface HydrateOptions {
    /** Whether to perform corrective actions on the data */
    corrective?: boolean;
    /** Cache duration in milliseconds */
    cache?: number;
    /** Logging function that accepts a log level and arguments */
    log?: (logLevel: string, ...args: unknown[]) => void;
}
/** The result of the hydrate operation containing both raw and hydrated data */
export interface HydrateReturn {
    /** The raw entries after processing */
    raw: RawEntry[];
    /** The hydrated entries with additional GitHub metadata */
    hydrated: HydratedEntry[];
}
/**
 * Trim redundant data from the listing and enhance with GitHub API data.
 * @param data An array of raw entries to hydrate with GitHub metadata
 * @param opts Configuration options for the hydration process including corrective mode, cache duration, and logging function
 * @returns A promise resolving to both raw and hydrated entry arrays
 */
export declare function hydrate(data: RawEntry[], opts?: HydrateOptions): Promise<HydrateReturn>;
//# sourceMappingURL=util.d.ts.map