Installations

npm install @types/html-encoding-sniffer

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Score

93.5

Supply Chain

86.2

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

143

Total

61,809

Closed

9,749

Merged

51,917

Issues

Open

565

Total

8,085

Closed

7,520

Releases

1

0.1.450

Updated on Sep 04, 2019

View All 1 releases

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.84%)

JavaScript (0.15%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

NOASSERTION License

50,021 Stars

89,735 Commits

30,435 Forks

640 Watchers

6 Branches

9,957 Contributors

Updated on Jul 11, 2025

Maintainers

1

View All 9,957 Contributors

Package Meta Information

Latest Version

3.0.2

Package Id

@types/html-encoding-sniffer@3.0.2

Unpacked Size

6.33 kB

Size

2.29 kB

File Count

5

Published on

Nov 07, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Installation

npm install --save @types/html-encoding-sniffer

Summary

This package contains type definitions for html-encoding-sniffer (https://github.com/jsdom/html-encoding-sniffer#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/html-encoding-sniffer.

index.d.ts

1/**
2 * Determine the Encoding of a HTML Byte Stream.
3 *
4 * Implements the HTML Standard's
5 * [encoding sniffing algorithm](https://html.spec.whatwg.org/multipage/syntax.html#encoding-sniffing-algorithm)
6 * in all its glory. The most interesting part of this is how it pre-scans the first 1024 bytes in order to search
7 * for certain `<meta charset>`-related patterns.
8 *
9 * @param htmlBytes The typed array containing the (X)HTML source text.
10 *
11 * @return The canonical [encoding name](https://encoding.spec.whatwg.org/#names-and-labels)
12 *         for use with the [`whatwg-encoding`](https://github.com/jsdom/whatwg-encoding) or similar package.
13 *
14 * @example
15 * import htmlEncodingSniffer = require("html-encoding-sniffer");
16 * import * as fs from "fs";
17 *
18 * const htmlBytes = fs.readFileSync("./html-page.html");
19 * const sniffedEncoding = htmlEncodingSniffer(htmlBytes);
20 */
21declare function sniffHTMLEncoding(htmlBytes: Uint8Array, options?: sniffHTMLEncoding.Options): string;
22
23declare namespace sniffHTMLEncoding {
24    interface Options {
25        /**
26         * An encoding label that is obtained from the "transport layer"
27         * (probably an HTTP `Content-Type` header), which overrides
28         * everything but a BOM.
29         */
30        transportLayerEncodingLabel?: string | undefined;
31
32        /**
33         * The ultimate fallback encoding used if no valid encoding is supplied
34         * by the transport layer, and no encoding is sniffed from the bytes.
35         *
36         * @default
37         * ```
38         * 'windows-1252'
39         * ```
40         *
41         * Which is recommended by the algorithm's table of suggested
42         * defaults for "All other locales" (including the `en` locale).
43         */
44        defaultEncoding?: string | undefined;
45    }
46}
47
48export = sniffHTMLEncoding;
49

Additional Details

Last updated: Tue, 07 Nov 2023 03:09:37 GMT
Dependencies: none

Credits

These definitions were written by ExE Boss, and BendingBender.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

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

9

Code-Review

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

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Token-Permissions

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

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-07-07

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