# bomstrip

> Node transformation stream that will strip a UTF-8 Byte Order Mark from the beginning.

Latest version **0.1.4** (published 2014-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install bomstrip
pnpm add bomstrip
yarn add bomstrip
bun add bomstrip
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2014-03-24 |
| First published | 2014-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Michael J. Ryan |
| Maintainers | tracker1 |
| Keywords | bom, utf8, stream, transform |

## Links

- npm: https://www.npmjs.com/package/bomstrip
- Repository: https://github.com/tracker1/node-bomstrip-stream
- Issues: https://github.com/tracker1/node-bomstrip-stream/issues
- npm.io page: https://npm.io/package/bomstrip

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2014-03-24
- 0.1.3 — 2014-03-24
- 0.1.2 — 2014-03-24
- 0.1.1 — 2014-03-24
- 0.1.0 — 2014-03-24

## README

node-bomstrip-stream
====================

Node.js transformation stream that will strip a UTF-8 Byte Order Mark from the beginning.

If you are dealing with text files that are edited and may include a Byte Order Mark (BOM) from the editor, this transform will easily remove those for use by the rest of your utility.  This is especially useful when accessing files created with editors in Windows, which will often be saved as UTF-8 with BOM. 

Usage
-----
    var fs = require('fs');
	var bomstrip = require('bomstrip');
	var stripped_stream = fs.createReadStream("path/to/file").pipe(new bomstrip());

Install
-------

    npm install --save bomstrip

Testing
----
TODO: Need to add unit tests, this is a very simple Transform stream that will simply strip the UTF-8 BOM bytes from the first portion of the stream.  Pull request(s) welcome.

---
_Source: https://npm.io/package/bomstrip · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._