diff options
Diffstat (limited to 'node_modules/strip-bom-buf/readme.md')
| -rw-r--r-- | node_modules/strip-bom-buf/readme.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/node_modules/strip-bom-buf/readme.md b/node_modules/strip-bom-buf/readme.md new file mode 100644 index 000000000..3c8f9bc49 --- /dev/null +++ b/node_modules/strip-bom-buf/readme.md @@ -0,0 +1,36 @@ +# strip-bom-buf [](https://travis-ci.org/sindresorhus/strip-bom-buf) + +> Strip UTF-8 [byte order mark](http://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a buffer + +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 --save strip-bom-buf +``` + + +## Usage + +```js +const fs = require('fs'); +const stripBomBuf = require('strip-bom-buf'); + +stripBomBuf(fs.readFileSync('unicorn.txt')); +//=> 'unicorn' +``` + + +## Related + +- [strip-bom](https://github.com/sindresorhus/strip-bom) - String version of this module +- [strip-bom-stream](https://github.com/sindresorhus/strip-bom-stream) - Stream version of this module + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |