@types/charset

Installation

npm install --save @types/charset

Summary

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

Details

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

index.d.ts

/// <reference types="node" />
import { IncomingHttpHeaders, IncomingMessage } from "http";

/**
 * guess data charset from req.headers, xml, html content-type meta tag
 *
 * headers:
 *
 *    'content-type': 'text/html;charset=gbk'
 *
 * meta tag:
 *
 *    <meta http-equiv="Content-Type" content="text/html; charset=xxxx"/>
 *
 * xml file:
 *
 *    <?xml version="1.0" encoding="UTF-8"?>
 *
 * @param obj `Content-Type` String, or `res.headers`, or `res` Object
 * @param data content buffer
 * @param peekSize max content peek size, default is 512
 * @return charset, lower case, e.g.: utf8, gbk, gb2312, .... If can\'t guess, return null
 */
declare function charset(
    obj: string | IncomingHttpHeaders | IncomingMessage,
    data?: Buffer,
    peekSize?: number,
): string | null;

export = charset;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/node

Credits

These definitions were written by Andrew Bradley.