Skip to content

Strip UTF-8 byte order mark (BOM) from a stream

License

Notifications You must be signed in to change notification settings

sindresorhus/strip-bom-stream

Repository files navigation

strip-bom-stream

Strip UTF-8 byte order mark (BOM) from a 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.

Install

$ npm install strip-bom-stream

Usage

import fs from 'node:fs';
import stripBomStream from 'strip-bom-stream';

fs.createReadStream('unicorn.txt')
	.pipe(stripBomStream())
	.pipe(fs.createWriteStream('unicorn.txt'));

It's a Transform stream.

Related