replace-in-file/types/index.d.ts

A simple utility to quickly replace text in one or more files.

declare module 'replace-in-file' {
  export function replaceInFile(config: ReplaceInFileConfig & { from?: never, to?: never, processor: ReplaceInFileConfig["processor"] }): Promise<ReplaceResult[]>;

  export function replaceInFile(config: ReplaceInFileConfig & { from: ReplaceInFileConfig["from"], to: ReplaceInFileConfig["to"], processor?: never }): Promise<ReplaceResult[]>;

  export default replaceInFile;

  export namespace replaceInFile {
    export function replaceInFileSync(config: ReplaceInFileConfig): ReplaceResult[];
    export function replaceInFile(config: ReplaceInFileConfig): Promise<ReplaceResult[]>;
  }

  export function replaceInFileSync(config: ReplaceInFileConfig): ReplaceResult[];

  export type From = string | RegExp | FromCallback;
  export type To = string | ToCallback;

  export interface ReplaceInFileConfig {
    files: string | string[];
    ignore?: string | string[];
    from?: From | Array<From>;
    to?: To | Array<To>;
    getTargetFile?(source: string): string;
    countMatches?: boolean;
    allowEmptyPaths?: boolean;
    disableGlobs?: boolean;
    encoding?: string;
    dry?: boolean;
    glob?: object;
    processor?: ProcessorCallback | Array<ProcessorCallback>;
    processorAsync?: ProcessorAsyncCallback | Array<ProcessorAsyncCallback>;
  }

  export interface ReplaceResult {
    file: string;
    hasChanged: boolean;
    numMatches?: number,
    numReplacements?: number,
  }
}

type FromCallback = (file: string) => string | RegExp | (RegExp | string)[];
type ToCallback = (match: string, file: string) => string | string[];
type ProcessorCallback = (input: string, file: string) => string;
type ProcessorAsyncCallback = (input: string, file: string) => Promise<string>;