replacer

transforming stream class

Showing:

Popularity

Downloads/wk

6

GitHub Stars

2

Maintenance

Last Commit

8yrs ago

Contributors

0

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

replacer

Build Status

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

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:

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:

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial