bare-encoding

bare-encoding — WHATWG text encoding interfaces for JavaScript.

npm i bare-encoding

Usage

const { TextEncoder, TextDecoder } = require('bare-encoding')

API

TextEncoder

encode(input: string): Buffer

Encode input as UTF-8 and return the result as a Buffer.

Parameters

encodeInto

encodeInto(input: string, destination: ArrayBufferView | ArrayBuffer | SharedArrayBuffer): { read: number; written: number }

Encode input as UTF-8 into destination. Returns the number of UTF-16 units of input read and the number of bytes written.

Parameters

TextEncoder.encoding: 'utf-8'

Always 'utf-8'.

TextDecoder

new TextDecoder(label?: string)

Create a TextDecoder for label. Only 'utf-8' (and its aliases) is supported; any other label throws.

Parameters

Throws

• INVALID_LABEL — label is not 'utf-8' or one of its aliases.

decode

decode(input: ArrayBufferView | ArrayBuffer | SharedArrayBuffer, options?: { stream: boolean }): string

Decode input to a string. If options.stream is true, buffers any incomplete trailing sequence for the next call instead of including it in the result.

Parameters

TextDecoder.encoding: 'utf-8'

The encoding this decoder was constructed with, always 'utf-8'.

bare-encoding/global

Types

TextEncoderConstructor

type TextEncoderConstructor = typeof encoding.TextEncoder

The type of the TextEncoder class, used to type the global TextEncoder constructor.

TextDecoderConstructor

type TextDecoderConstructor = typeof encoding.TextDecoder

The type of the TextDecoder class, used to type the global TextDecoder constructor.

bare-encoding/errors

EncodingError

code: string

The error code identifying the failure.

EncodingError.INVALID_LABEL(msg: string): EncodingError

The label passed to TextDecoder is not a valid encoding.

Parameters

Returns EncodingError — An EncodingError with code set to 'INVALID_LABEL', for the caller to throw.

See also

• Bare modules — the full bare-* catalog.
• Bare runtime API — the runtime these modules extend.