replace-in-file

Install

npm i replace-in-file

yarn add replace-in-file

pnpm add replace-in-file

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

module 'replace-in-file' {}

replaceInFile: typeof replaceInFile;

replaceInFileSync: (config: ReplaceInFileConfig) => ReplaceResult[];

interface ReplaceInFileConfig {}

allowEmptyPaths?: boolean;

countMatches?: boolean;

disableGlobs?: boolean;

dry?: boolean;

encoding?: string;

files: string | string[];

from?: From | Array<From>;

glob?: object;

ignore?: string | string[];

processor?: ProcessorCallback | Array<ProcessorCallback>;

processorAsync?: ProcessorAsyncCallback | Array<ProcessorAsyncCallback>;

to?: To | Array<To>;

getTargetFile: (source: string) => string;

interface ReplaceResult {}

file: string;

hasChanged: boolean;

numMatches?: number;

numReplacements?: number;

type From = string | RegExp | FromCallback;

type To = string | ToCallback;

namespace replace-in-file.replaceInFile {}

replaceInFile: (config: ReplaceInFileConfig) => Promise<ReplaceResult[]>;

replaceInFileSync: (config: ReplaceInFileConfig) => ReplaceResult[];

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/replace-in-file.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/replace-in-file)

HTML

<a href="https://www.jsdocs.io/package/replace-in-file"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>