strip-bom
Advanced tools
Package description
The strip-bom package is used to remove a UTF-8 byte order mark (BOM) from the beginning of a string. This is particularly useful when dealing with files or data streams that may have been saved with a BOM, which can cause issues when processing or parsing the text.
Removing BOM from a string
This code demonstrates how to use strip-bom to remove a byte order mark from the beginning of a string. It's useful for processing text that originates from files encoded with a BOM.
const stripBom = require('strip-bom');
const stringWithBom = '\uFEFFThis is a test string.';
const cleanedString = stripBom(stringWithBom);
console.log(cleanedString); // 'This is a test string.'Similar to strip-bom, but designed for use with streams. It allows for the removal of the BOM from streams of data, making it useful for processing files or data in real-time. This package is a good choice when working with large files or in situations where data is being streamed.
This package offers functionality similar to strip-bom but operates on buffers instead of strings. It's particularly useful when dealing with binary data or when reading files into buffers before processing. This can be advantageous for performance in certain scenarios.
Readme
Strip UTF-8 byte order mark (BOM) from a string/buffer/stream
From Wikipedia:
The Unicode Standard permits the BOM in UTF-8, but does not require nor recommend its use. Byte order has no meaning in UTF-8.
$ npm install --save strip-bom
var fs = require('fs');
var stripBom = require('strip-bom');
stripBom('\ufeffUnicorn');
//=> Unicorn
stripBom(fs.readFileSync('unicorn.txt'));
//=> Unicorn
Or as a Transform stream:
var fs = require('fs');
var stripBom = require('strip-bom');
fs.createReadStream('unicorn.txt')
.pipe(stripBom.stream())
.pipe(fs.createWriteStream('unicorn.txt'));
$ npm install --global strip-bom
$ strip-bom --help
Usage
strip-bom <file> > <new-file>
cat <file> | strip-bom > <new-file>
Example
strip-bom unicorn.txt > unicorn-without-bom.txt
MIT © Sindre Sorhus
FAQs
Strip UTF-8 byte order mark (BOM) from a string
The npm package strip-bom receives a total of 51,874,360 weekly downloads. As such, strip-bom popularity was classified as popular.
We found that strip-bom demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.