Interface IEncoding

Represents a character encoding.

Hierarchy

IEncoding

Index

Methods

Methods

byteLength

byteLength(str: string): number

- Defined in src/encoding.ts:15
Returns the byte length of a string when encoded using this encoding

Parameters
- str: string
  
  A value to calculate the length of.
Returns number

Optional decode

decode(buf: Buffer): string

- Defined in src/encoding.ts:20
Decode a buffer to a string. Any incomplete characters will be replaced with substitution characters appropriate for the character encoding.

Parameters
- buf: Buffer
  
  A buffer to decode.
Returns string

encode

encode(str: string): Buffer

- Defined in src/encoding.ts:25
Encode a string to a buffer. Any incomplete characters will be replaced with substitution characters and encoded appropriate for the character encoding.

Parameters
- str: string
  
  A string to encode.
Returns Buffer

getDecoder

getDecoder(): IDecoder

- Defined in src/encoding.ts:8
Obtain a decoder that converts an encoded sequence of bytes into string.

Returns IDecoder

Optional getEncoder

getEncoder(): IEncoder

- Defined in src/encoding.ts:10
Obtains an encoder that converts a sequence of Unicode characters into an encoded sequence of bytes.

Returns IEncoder

Generated using TypeDoc