html-encoding-sniffer
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/html-encoding-sniffer package

    2.0.1 • Public • Published

    Determine the Encoding of a HTML Byte Stream

    This package implements the HTML Standard's encoding sniffing algorithm in all its glory. The most interesting part of this is how it pre-scans the first 1024 bytes in order to search for certain <meta charset>-related patterns.

    const htmlEncodingSniffer = require("html-encoding-sniffer");
    const fs = require("fs");
     
    const htmlBuffer = fs.readFileSync("./html-page.html");
    const sniffedEncoding = htmlEncodingSniffer(htmlBuffer);

    The returned value will be a canonical encoding name (not a label). You might then combine this with the whatwg-encoding package to decode the result:

    const whatwgEncoding = require("whatwg-encoding");
    const htmlString = whatwgEncoding.decode(htmlBuffer, sniffedEncoding);

    Options

    You can pass two potential options to htmlEncodingSniffer:

    const sniffedEncoding = htmlEncodingSniffer(htmlBuffer, {
      transportLayerEncodingLabel,
      defaultEncoding
    });

    These represent two possible inputs into the encoding sniffing algorithm:

    • transportLayerEncodingLabel is an encoding label that is obtained from the "transport layer" (probably a HTTP Content-Type header), which overrides everything but a BOM.
    • defaultEncoding is the ultimate fallback encoding used if no valid encoding is supplied by the transport layer, and no encoding is sniffed from the bytes. It defaults to "windows-1252", as recommended by the algorithm's table of suggested defaults for "All other locales" (including the en locale).

    Credits

    This package was originally based on the excellent work of @nicolashenry, in jsdom. It has since been pulled out into this separate package.

    Keywords

    Install

    npm i html-encoding-sniffer

    DownloadsWeekly Downloads

    5,733,441

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    11.5 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar