encoding-sniffer

An implementation of the HTML encoding sniffer algo, with stream support.

This module wraps around iconv-lite to make decoding buffers and streams incredibly easy.

Features

• Support for streams
• Support for XML encoding types, including UTF-16 prefixes and <?xml encoding="...">
• Allows decoding streams and buffers with a single function call

Installation

1npm install encoding-sniffer

Usage

1import { DecodeStream, getEncoding, decodeBuffer } from "encoding-sniffer";
2
3/**
4 * All functions accept an optional options object.
5 *
6 * Available options are (with default values):
7 */
8const options = {
9    /**
10     * The maximum number of bytes to sniff. Defaults to `1024`.
11     */
12    maxBytes: 1024,
13    /**
14     * The encoding specified by the user. If set, this will only be overridden
15     * by a Byte Order Mark (BOM).
16     */
17    userEncoding: undefined,
18    /**
19     * The encoding specified by the transport layer. If set, this will only be
20     * overridden by a Byte Order Mark (BOM) or the user encoding.
21     */
22    transportLayerEncodingLabel: undefined,
23    /**
24     * The default encoding to use, if no encoding can be detected.
25     *
26     * Defaults to `"windows-1252"`.
27     */
28    defaultEncoding: "windows-1252",
29};
30
31// Use the `DecodeStream` transform stream to automatically decode
32// the contents of a stream as they are read
33const decodeStream = new DecodeStream(options);
34
35// Or, use the `getEncoding` function to detect the encoding of a buffer
36const encoding = getEncoding(buffer, options);
37
38// Use the `decodeBuffer` function to decode the contents of a buffer
39const decodedBuffer = decodeBuffer(buffer, options);

License

This project is licensed under the MIT License. See the LICENSE file for more information.