26 lines
1.2 KiB
TypeScript
26 lines
1.2 KiB
TypeScript
/// <reference types="node" />
|
|
import { BufferLike, DecodeOptions, EncodeOptions, StringEncoding } from "./native";
|
|
export * from "./errors";
|
|
export * from "./native";
|
|
/**
|
|
* Convenience alias for {@link StringEncoding.decode}.
|
|
*
|
|
* @param text - The encoded text.
|
|
* @param encoding - The encoding of the `text`. May be an IANA character set name or a {@link StringEncoding}.
|
|
* @param options - Options for decoding.
|
|
* @returns The decoded text, as a string.
|
|
*/
|
|
export declare function decode(text: BufferLike, encoding: string | StringEncoding, options?: DecodeOptions): string;
|
|
/**
|
|
* Convenience alias for {@link StringEncoding.encode}.
|
|
*
|
|
* @remarks
|
|
* Throws {@link NotRepresentableError} if the `text` cannot be fully represented in this encoding, and `options` does not contain a `lossByte`.
|
|
*
|
|
* @param text - The text to encode.
|
|
* @param encoding - The encoding to use. May be an IANA character set name or a {@link StringEncoding}.
|
|
* @param options - Options for encoding.
|
|
* @returns The encoded text, in a `Buffer`.
|
|
*/
|
|
export declare function encode(text: string, encoding: string | StringEncoding, options?: EncodeOptions): Buffer;
|
|
//# sourceMappingURL=index.d.ts.map
|