History

Theunis J. Botha 5f5bbac56e initial comit		2020-02-27 15:24:35 +01:00
..
LICENSE	initial comit	2020-02-27 15:24:35 +01:00
README.md	initial comit	2020-02-27 15:24:35 +01:00
index.js	initial comit	2020-02-27 15:24:35 +01:00
package.json	initial comit	2020-02-27 15:24:35 +01:00

README.md

remove-bom-stream

Remove a UTF8 BOM at the start of the stream.

Usage

var fs = require('fs');
var concat = require('concat-stream');
var removeBOM = require('remove-bom-stream');

fs.createReadStream('utf8-file-with-bom.txt')
  .pipe(removeBOM())
  .pipe(concat(function(result) {
    // result won't have a BOM
  }));

API

`removeBOM()`

Returns a through2 stream that will remove a BOM, given the data is a UTF8 Buffer with a BOM at the beginning. If the data is not UTF8 or does not have a BOM, the data is not changed and this becomes a normal passthrough stream.

License

MIT