Natively Pluggable Module

    remove-bom-stream

    2.0.0 • Public • Published

    remove-bom-stream

    NPM version Downloads Build Status Coveralls Status

    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('utf-8'))
      .pipe(
        concat(function (result) {
          // result won't have a BOM
        })
      );

    API

    removeBOM(encoding)

    Returns a Transform stream that will remove a BOM, if the argument encoding is 'utf-8' and the given data is a UTF8 Buffer with a BOM at the beginning. If the encoding is not 'utf-8' or does not have a BOM, the data is not changed and this becomes a no-op Transform stream.

    License

    MIT

    Install

    npm i remove-bom-stream

    DownloadsWeekly Downloads

    1,279,287

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    5.3 kB

    Total Files

    4

    Last publish

    Collaborators

    • yocontra
    • phated