Blame view

node_modules/strip-bom/readme.md 902 Bytes
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  # strip-bom [![Build Status](https://travis-ci.org/sindresorhus/strip-bom.svg?branch=master)](https://travis-ci.org/sindresorhus/strip-bom)
  
  > Strip UTF-8 [byte order mark](http://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) (BOM) from a string/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
  ```
  
  
  ## Usage
  
  ```js
  var fs = require('fs');
  var stripBom = require('strip-bom');
  
  stripBom('\uFEFFunicorn');
  //=> 'unicorn'
  
  stripBom(fs.readFileSync('unicorn.txt'));
  //=> 'unicorn'
  ```
  
  
  ## Related
  
  - [strip-bom-cli](https://github.com/sindresorhus/strip-bom-cli) - CLI for this module
  - [strip-bom-stream](https://github.com/sindresorhus/strip-bom-stream) - Stream version of this module
  
  
  ## License
  
  MIT © [Sindre Sorhus](http://sindresorhus.com)