Installation

npm install --save @types/chardet

Summary

This package contains type definitions for chardet (https://github.com/runk/node-chardet).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chardet.

index.d.ts

// Type definitions for chardet 0.8
// Project: https://github.com/runk/node-chardet
// Definitions by: Hauke Oldsen <https://github.com/Gebatzens>
//                 Sam Hinshaw <https://github.com/samhinshaw>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />

export interface Confidence {
    name: string;
    confidence: number;
    lang?: string | undefined;
}

export interface Options {
    returnAllMatches?: boolean | undefined;
    sampleSize?: number | undefined;
}

// As of v0.6, these fns return the highest-confidence result
export function detect(buf: Buffer, opts?: Options): string | null;

export function detectFile(path: string, cb: (err: any, result: string | null) => void): void;
export function detectFile(path: string, opts: Options, cb: (err: any, result: string | null) => void): void;

export function detectFileSync(path: string, opts?: Options): string | null;

// These fns were introduced in v0.6 to return an array of confidences.
export function detectAll(buf: Buffer, opts?: Options): Confidence[] | null;

export function detectFileAll(path: string, cb: (err: any, result: Confidence[] | null) => void): void;
export function detectFileAll(path: string, opts: Options, cb: (err: any, result: Confidence[] | null) => void): void;

export function detectFileAllSync(path: string, opts?: Options): Confidence[] | null;

Additional Details

Last updated: Tue, 06 Jul 2021 18:05:50 GMT
Dependencies: @types/node
Global values: none

Credits

These definitions were written by Hauke Oldsen, and Sam Hinshaw.

Current Tags

3 Versions

0.8.1 ... 5 years ago
0.8.0 ... 6 years ago
0.5.0 ... 8 years ago