import type { SuiteReport } from '../types.js';
import type { Logger, ILogObj } from 'tslog';
/**
 * Options for configuring the FileStore.
 */
export interface FileStoreOptions {
    /**
     * The directory where the benchmark report file will be saved.
     * @default './benchmarks/history'
     */
    basePath?: string;
    /**
     * The logger instance to use for logging messages.
     */
    logger?: Logger<ILogObj>;
    /**
     * The filesystem module to use for file operations.
     * This is primarily used for testing purposes. However, it can also be used to
     * provide a custom implementation of the filesystem module (in a browser, for example).
     * @default 'fs/promises'
     */
    fs?: {
        mkdir: (path: string, options: {
            recursive: boolean;
        }) => Promise<void>;
        readdir: (path: string) => Promise<string[]>;
        readFile: (path: string, encoding: string) => Promise<string>;
    };
    /**
     * The path module to use for path operations.
     * This is primarily used for testing purposes. However, it can also be used to
     * provide a custom implementation of the path module (in a browser, for example).
     * @default 'path'
     */
    path?: {
        join: (...paths: string[]) => string;
    };
}
/**
 * A class to manage the file storage of benchmark history.
 *
 * It allows you to store benchmark result as files in a specific directory.
 * The `T` type parameter is used to specify the type of the benchmark result,
 * which is also used as a suffix for the base path of the storage.
 *
 * @example
 * const fileStore = new FileStore<'Suite1' | 'Suite2' | 'Suite3'>();
 * const historyPath = fileStore.getHistoryPath('Suite1');
 * console.log(historyPath); // './benchmarks/history/Suite1'
 *
 * @example
 * const fileStore = new FileStore();
 * const historyPath = fileStore.getHistoryPath();
 * console.log(historyPath); // './benchmarks/history'
 *
 * @example
 * // Integrating with the `FileReporter` class:
 * const fileStore = new FileStore<'Suite1' | 'Suite2' | 'Suite3'>();
 * const file = new FileReporter({ outputDir: fileStore.getHistoryPath('Suite2') })
 * await fileStore.loadLatestBenchmark('Suite2')
 * // run the suite
 * const result = await suite.addReporter(file, 'after-all').run()
 * fileStore.compareLatest(result)
 */
export declare class FileStore<T = undefined> {
    /**
     * The base path where the history of executions is stored.
     * This path is relative to the current working directory.
     */
    basePath: string;
    /**
     * The passed configuration options.
     */
    protected options: FileStoreOptions;
    /**
     * The latest benchmark result file.
     * This property is set when the `loadLatestBenchmark()` method is called.
     */
    latest?: SuiteReport;
    /**
     * The logger to use for logging messages.
     */
    logger: Logger<ILogObj>;
    constructor(options?: FileStoreOptions);
    /**
     * Computes the file path to the history of executions.
     *
     * @param type - The type of the benchmark result.
     * If provided, it will be used to create a specific path for the benchmark result.
     * If not provided, the base path will be used.
     */
    getHistoryPath(type?: T): string;
    /**
     * Lists all the benchmark result files in the specified directory.
     * When the type is not provided, it lists all files in the base path.
     * When the type is provided, it lists files in the specific directory for that type.
     *
     * @param type The type of the benchmark result.
     * @returns The list of files in the specified directory. Files are sorted in ascending order.
     */
    list(type: T): Promise<string[]>;
    /**
     * Retrieves the latest benchmark result file from the specified directory.
     * When the type is not provided, it retrieves the latest file from the base path.
     * When the type is provided, it retrieves the latest file from the specific directory for that type.
     *
     * @param type The type of the benchmark result.
     * @returns The latest benchmark result file as a JSON object.
     */
    loadLatestBenchmark(type: T): Promise<SuiteReport | undefined>;
    /**
     * Compares the latest benchmark result with the current benchmark result.
     * If no previous benchmark result is found, it logs a message to the console.
     *
     * @param result The current benchmark result to compare with the latest one.
     * @param latest The latest benchmark result to compare with.
     * If not provided, the method will use the latest benchmark result loaded by `loadLatestBenchmark()`.
     */
    compareLatest(result: SuiteReport, latest?: SuiteReport | undefined): void;
}
//# sourceMappingURL=file_store.d.ts.map