# replacer

> Transform stream that performs text search and replacements

Latest version **0.0.1** (published 2013-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install replacer
pnpm add replacer
yarn add replacer
bun add replacer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2013-12-19 |
| First published | 2013-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Steve Molitor |
| Maintainers | stevemolitor |
| Keywords | search, replace, stream, transform |

## Links

- npm: https://www.npmjs.com/package/replacer
- Repository: https://github.com/apto/replacer
- Issues: https://github.com/apto/replace/issues
- npm.io page: https://npm.io/package/replacer

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2013-12-19

## README

# replacer

[![Build Status](https://secure.travis-ci.org/apto/replacer.png)](http://travis-ci.org/apto/replacer)

Node.js transform stream that performs text based search and replacements.  It performs correctly over chunk boundaries, and is efficient when performing multiple search / replacements over a stream of text.

## Installation

```shell
npm install replacer
```

## Usage

### Streaming search and replace

Let's say we have the following text file:
```
// story.txt
The cow ate the pig.
The cow ate the hen.
The cow ate the horse.
```

To replace all occurrences of 'cow' with 'dog' we could do this:

```js
var fs = require('fs');
var path = require('path');
var Replacer = require('replacer');

var filePath = path.resolve(__dirname, 'story.txt');
fs.createReadStream(filePath)
  .pipe(new Replacer('cow', 'dog'))
  .pipe(process.stdout);
```

This will print:

```
The dog ate the pig.
The dog ate the hen.
The dog ate the horse.
```

### Multiple replacements

To perform multiple replacements:

```js
var replacements = [
  { search: 'cow', replace: 'dog' },
  { search: 'pig', replace: 'fox' },
  { search: 'hen', replace: 'hog' }
];

fs.createReadStream(filePath)
  .pipe(new Replacer(replacements))
  .pipe(process.stdout);
```

This would print:

```
The dog ate the fox.
The dog ate the hog.
The dog ate the horse.
```

### See Also
Replacer was insipired by
[replacestream](https://github.com/eugeneware/replacestream).

---
_Source: https://npm.io/package/replacer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._