util.TextEncoder

History

An implementation of the WHATWG Encoding Standard TextEncoder API. All instances of TextEncoder only support UTF-8 encoding.

const encoder = new TextEncoder();
const uint8array = encoder.encode('this is some data');

JavaScript

The TextEncoder class is also available on the global object.

textEncoder.encode

textEncoder.encode(input?): Uint8Array

Attributes

input?:string

The text to encode. Default: an empty string.

Returns:Uint8Array

UTF-8 encodes the input string and returns a Uint8Array containing the encoded bytes.

textEncoder.encodeInto

History

textEncoder.encodeInto(src, dest): Object

Attributes

src:string

The text to encode.

dest:Uint8Array

The array to hold the encode result.

Returns:Object

read:number

The read Unicode code units of src.

written:number

The written UTF-8 bytes of dest.

UTF-8 encodes the src string to the dest Uint8Array and returns an object containing the read Unicode code units and written UTF-8 bytes.

const encoder = new TextEncoder();
const src = 'this is some data';
const dest = new Uint8Array(10);
const { read, written } = encoder.encodeInto(src, dest);

JavaScript

textEncoder.encoding

Type:string

The encoding supported by the TextEncoder instance. Always set to 'utf-8'.