# strip-bom-buffer

> Strip a byte order mark (BOM) from a buffer.

Latest version **1.0.1** (published 2017-06-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install strip-bom-buffer
pnpm add strip-bom-buffer
yarn add strip-bom-buffer
bun add strip-bom-buffer
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-06-16 |
| First published | 2015-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Jon Schlinkert |
| Maintainers | phated, jonschlinkert |
| Keywords | bom, buffer, byte-order-mark, file, fs, nl, normalize, strip |

## Links

- npm: https://www.npmjs.com/package/strip-bom-buffer
- Repository: https://github.com/jonschlinkert/strip-bom-buffer
- Issues: https://github.com/jonschlinkert/strip-bom-buffer/issues
- npm.io page: https://npm.io/package/strip-bom-buffer

## Dependencies (2)

- [is-utf8](https://npm.io/package/is-utf8.md) ^0.2.1
- [is-buffer](https://npm.io/package/is-buffer.md) ^1.1.5

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-06-16
- 1.0.0 — 2017-03-30
- 0.1.1 — 2015-10-10
- 0.1.0 — 2015-10-10

## README

# strip-bom-buffer [![NPM version](https://img.shields.io/npm/v/strip-bom-buffer.svg?style=flat)](https://www.npmjs.com/package/strip-bom-buffer) [![NPM monthly downloads](https://img.shields.io/npm/dm/strip-bom-buffer.svg?style=flat)](https://npmjs.org/package/strip-bom-buffer)  [![NPM total downloads](https://img.shields.io/npm/dt/strip-bom-buffer.svg?style=flat)](https://npmjs.org/package/strip-bom-buffer) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/strip-bom-buffer.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/strip-bom-buffer)

> Strip a byte order mark (BOM) from a buffer.

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install --save strip-bom-buffer
```

## Usage

```js
var strip = require('strip-bom-buffer');
strip(new Buffer('\ufefffoo'));
```

## About

### Related projects

* [cr](https://www.npmjs.com/package/cr): Strip windows carriage returns, or convert carriage returns to newlines. | [homepage](https://github.com/jonschlinkert/cr "Strip windows carriage returns, or convert carriage returns to newlines.")
* [has-bom](https://www.npmjs.com/package/has-bom): Returns true if a buffer or string has a byte order mark (BOM) | [homepage](https://github.com/jonschlinkert/has-bom "Returns true if a buffer or string has a byte order mark (BOM)")
* [read-file](https://www.npmjs.com/package/read-file): Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when `utf8` encoding… [more](https://github.com/jonschlinkert/read-file) | [homepage](https://github.com/jonschlinkert/read-file "Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when `utf8` encoding is chosen. Also optionally replaces windows newlines with unix newlines.")
* [strip-bom-string](https://www.npmjs.com/package/strip-bom-string): Strip a byte order mark (BOM) from a string. | [homepage](https://github.com/jonschlinkert/strip-bom-string "Strip a byte order mark (BOM) from a string.")

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Building docs

_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_

To generate the readme, run the following command:

```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh
$ npm install && npm test
```

### Author

**Jon Schlinkert**

* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 29, 2017._

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