mirror of https://github.com/GeekOops/doc.git synced 2024-05-20 05:12:21 +00:00

History

Felix Niederwanger 4c3db73df3 Move content to repo root		2021-05-05 15:50:12 +02:00
..
index.js	Move content to repo root	2021-05-05 15:50:12 +02:00
LICENSE	Move content to repo root	2021-05-05 15:50:12 +02:00
package.json	Move content to repo root	2021-05-05 15:50:12 +02:00
README.md	Move content to repo root	2021-05-05 15:50:12 +02: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