encoding-japanese/index.d.ts

Convert and detect character encodings in JavaScript

// TypeScript declarations originally from DefinitelyTyped
// Upstream package: @types/encoding-japanese 2.2.1
// Thanks to the DefinitelyTyped contributors
// Licensed under the MIT License. See the LICENSE file

export as namespace Encoding;

export type Encoding =
    | "UTF32"
    | "UTF16"
    | "UTF16BE"
    | "UTF16LE"
    | "BINARY"
    | "ASCII"
    | "JIS"
    | "UTF8"
    | "EUCJP"
    | "SJIS"
    | "UNICODE"
    | "AUTO";
type IntArrayType =
    | readonly number[]
    | Uint8Array
    | Uint16Array
    | Uint32Array
    | Int8Array
    | Int16Array
    | Int32Array;
type EncodingDetection = Encoding | false;

export type ConvertOptions =
    | ConvertStringOptions
    | ConvertArrayBufferOptions
    | ConvertArrayOptions
    | ConvertUnknownOptions;

export interface ConvertStringOptions {
    to: Encoding;
    from?: Encoding | undefined;
    type: "string";
    fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error";
    bom?: boolean | string | undefined;
}

export interface ConvertArrayBufferOptions {
    to: Encoding;
    from?: Encoding | undefined;
    type: "arraybuffer";
    fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error";
    bom?: boolean | string | undefined;
}

export interface ConvertArrayOptions {
    to: Encoding;
    from?: Encoding | undefined;
    type: "array";
    fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error";
    bom?: boolean | string | undefined;
}

export interface ConvertUnknownOptions {
    to: Encoding;
    from?: Encoding | undefined;
    fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error";
    bom?: boolean | string | undefined;
}

export function detect(data: IntArrayType | string, encodings?: Encoding | Encoding[]): EncodingDetection;
export function convert(data: IntArrayType, to: Encoding, from?: Encoding): number[];
export function convert(data: string, to: Encoding, from?: Encoding): string;
export function convert(data: IntArrayType | string, options: ConvertStringOptions): string;
export function convert(data: IntArrayType | string, options: ConvertArrayBufferOptions): Uint16Array;
export function convert(data: IntArrayType | string, options: ConvertArrayOptions): number[];
export function convert(data: string, options: ConvertUnknownOptions): string;
export function convert(data: IntArrayType, options: ConvertUnknownOptions): number[];
export function urlEncode(data: IntArrayType): string;
export function urlDecode(data: string): number[];
export function base64Encode(data: IntArrayType): string;
export function base64Decode(data: string): number[];
export function codeToString(data: IntArrayType): string;
export function stringToCode(data: string): number[];
export function toHankakuCase(data: readonly number[]): number[];
export function toHankakuCase(data: string): string;
export function toZenkakuCase(data: readonly number[]): number[];
export function toZenkakuCase(data: string): string;
export function toHiraganaCase(data: readonly number[]): number[];
export function toHiraganaCase(data: string): string;
export function toKatakanaCase(data: readonly number[]): number[];
export function toKatakanaCase(data: string): string;
export function toHankanaCase(data: readonly number[]): number[];
export function toHankanaCase(data: string): string;
export function toZenkanaCase(data: readonly number[]): number[];
export function toZenkanaCase(data: string): string;
export function toHankakuSpace(data: readonly number[]): number[];
export function toHankakuSpace(data: string): string;
export function toZenkakuSpace(data: readonly number[]): number[];
export function toZenkakuSpace(data: string): string;

export const version: string;
export const orders: string[];

export {};