Installations

npm install html-encoding-sniffer

Pull Requests

Open

0

Total

9

Closed

1

Merged

8

Issues

Open

2

Total

8

Closed

6

Releases

7

4.0.0

v4.0.0

Published on 12 Nov 2023

3.0.0

v3.0.0

Published on 18 Sept 2021

2.0.1

v2.0.1

Published on 23 Feb 2020

2.0.0

v2.0.0

Published on 23 Feb 2020

1.0.2

v1.0.2

Published on 23 Oct 2017

1.0.1

v1.0.1

Published on 16 Oct 2016

View all 7 releases

Developer

jsdom

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=18

Typescript Support

No

Node Version

21.1.0

NPM Version

10.2.0 Statistics

19 Stars

25 Commits

11 Forks

5 Watching

2 Branches

7 Contributors

Updated on 23 May 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

4,348,207,687

Last day

-8.3%

4,959,657

Compared to previous day

Last week

2.6%

29,615,921

Compared to previous week

Last month

22.7%

115,812,843

Compared to previous month

Last year

11.3%

1,089,188,827

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

whatwg-encoding

Dev Dependencies

2

eslint @domenic/eslint-config

Versions

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.

1const htmlEncodingSniffer = require("html-encoding-sniffer");
2const fs = require("fs");
3
4const htmlBytes = fs.readFileSync("./html-page.html");
5const sniffedEncoding = htmlEncodingSniffer(htmlBytes);

The passed bytes are given as a Uint8Array; the Node.js Buffer subclass of Uint8Array will also work, as shown above.

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:

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

Options

You can pass two potential options to htmlEncodingSniffer:

1const sniffedEncoding = htmlEncodingSniffer(htmlBytes, {
2  transportLayerEncodingLabel,
3  defaultEncoding
4});

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.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More