remove-bom-stream

What is remove-bom-stream?

The remove-bom-stream npm package is designed to remove Byte Order Marks (BOM) from streams. BOMs are special markers at the start of a text stream that indicate the encoding used. This package is particularly useful when dealing with text files that may have BOMs, which can cause issues in processing or parsing the text.

What are remove-bom-stream's main functionalities?

Remove BOM from a stream

This feature allows you to remove the BOM from a readable stream and pipe the cleaned data into a writable stream. In this example, the BOM is removed from 'input.txt' and the result is written to 'output.txt'.

const fs = require('fs');
const removeBomStream = require('remove-bom-stream');

fs.createReadStream('input.txt')
  .pipe(removeBomStream())
  .pipe(fs.createWriteStream('output.txt'));

Other packages similar to remove-bom-stream

strip-bom-stream

The strip-bom-stream package also removes BOM from streams. It is similar to remove-bom-stream in functionality but may have different performance characteristics or additional features. Both packages are used to clean BOMs from text streams, making them suitable for similar use cases.

strip-bom

The strip-bom package is used to remove BOM from strings and buffers rather than streams. While it serves a similar purpose, it is more suitable for scenarios where you are dealing with text data in memory rather than streaming data.

README

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('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

Changelog

2.0.0 (2022-04-19)

⚠ BREAKING CHANGES

• Switch to streamx for streams (#10)
• Require encoding option to avoid inspecting chunks for UTF-8 encoding (#8)
• Normalize repository, dropping node <10.13 support (#3)

Features

• Remove the dependency on remove-bom-buffer (2107f34)
• Require encoding option to avoid inspecting chunks for UTF-8 encoding (#8) (2107f34)
• Switch to streamx for streams (#10) (9867811)
• Use node core's TextDecoder to process beginning of stream (2107f34)

Bug Fixes

• Handle first chunk shorter than 7 bytes correctly when next chunks are larger (#7) (564f87b)

Miscellaneous Chores

• Normalize repository, dropping node <10.13 support (#3) (8fece9c)