www.aleph1.co.uk Git - yaffs-website/blob - node_modules/strip-bom/readme.md

   1 # strip-bom [![Build Status](https://travis-ci.org/sindresorhus/strip-bom.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-bom)
   2
   3 > Strip UTF-8 [byte order mark](http://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a string/buffer/stream
   4
   5 From Wikipedia:
   6
   7 > 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.
   8
   9
  10 ## Usage
  11
  12 ```sh
  13 $ npm install --save strip-bom
  14 ```
  15
  16 ```js
  17 var fs = require('fs');
  18 var stripBom = require('strip-bom');
  19
  20 stripBom('\ufeffUnicorn');
  21 //=> Unicorn
  22
  23 stripBom(fs.readFileSync('unicorn.txt'));
  24 //=> Unicorn
  25 ```
  26
  27 Or as a [Transform stream](http://nodejs.org/api/stream.html#stream_class_stream_transform):
  28
  29 ```js
  30 var fs = require('fs');
  31 var stripBom = require('strip-bom');
  32
  33 fs.createReadStream('unicorn.txt')
  34         .pipe(stripBom.stream())
  35         .pipe(fs.createWriteStream('unicorn.txt'));
  36 ```
  37
  38
  39 ## CLI
  40
  41 ```sh
  42 $ npm install --global strip-bom
  43 ```
  44
  45 ```
  46 $ strip-bom --help
  47
  48   Usage
  49     strip-bom <file> > <new-file>
  50     cat <file> | strip-bom > <new-file>
  51
  52   Example
  53     strip-bom unicorn.txt > unicorn-without-bom.txt
  54 ```
  55
  56
  57 ## License
  58
  59 MIT © [Sindre Sorhus](http://sindresorhus.com)