diff options
Diffstat (limited to 'node_modules/iconv-lite/README.md')
| -rw-r--r-- | node_modules/iconv-lite/README.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/node_modules/iconv-lite/README.md b/node_modules/iconv-lite/README.md index 160b7cf65..07955de2b 100644 --- a/node_modules/iconv-lite/README.md +++ b/node_modules/iconv-lite/README.md @@ -8,6 +8,7 @@ * Streaming support for Node v0.10+ * [Deprecated] Can extend Node.js primitives (buffers, streams) to support all iconv-lite encodings. * In-browser usage via [Browserify](https://github.com/substack/node-browserify) (~180k gzip compressed with Buffer shim included). + * Typescript [type definition file](https://github.com/ashtuchkin/iconv-lite/blob/master/lib/index.d.ts) included. * License: MIT. [](https://npmjs.org/packages/iconv-lite/) @@ -120,6 +121,7 @@ Note: your results may vary, so please always check on your hardware. * Decoding: BOM is stripped by default, unless overridden by passing `stripBOM: false` in options (f.ex. `iconv.decode(buf, enc, {stripBOM: false})`). A callback might also be given as a `stripBOM` parameter - it'll be called if BOM character was actually found. + * If you want to detect UTF-8 BOM when decoding other encodings, use [node-autodetect-decoder-stream](https://github.com/danielgindi/node-autodetect-decoder-stream) module. * Encoding: No BOM added, unless overridden by `addBOM: true` option. ## UTF-16 Encodings @@ -154,4 +156,4 @@ $ open coverage/lcov-report/index.html ## Adoption [](https://nodei.co/npm/iconv-lite/) -[](https://www.codeship.io/projects/29053) +[](https://www.codeship.com/projects/29053) |