checksync/dist/load-migration-config.d.ts

A tool that allows code to be annotated across different files to ensure they remain in sync.

import { ILog, MigrationOptions } from "./types";
type MigrationConfig = {
    mode: "all" | "missing";
    mappings: Array<{
        from: Array<string>;
        to: string;
    }>;
};
/**
 * Load the migration options from the migration configuration.
 *
 * This takes the migration configuration, which maps the intended target
 * prefix to the prefixes that should be migrated to that target prefix, and
 * returns the migration options that can be used to migrate those prefixes.
 *
 * @param migrationConfig The migration configuration.
 * @param log The log to use for reporting errors.
 * @returns The migration options, or undefined if there are no mappings.
 * @throws An error if there are duplicate prefixes in the migration
 * configuration.
 */
export declare const loadMigrationConfig: (migrationConfig: MigrationConfig | undefined, log: ILog) => MigrationOptions | undefined;
export {};