DocsReferenceGuidesBlog
Discord logo
Discord
GitHub logo
Bun

class

util.TextEncoder

class TextEncoder

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');

The TextEncoder class is also available on the global object.

  • readonly encoding: string

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

  • input?: string

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

    @param input

    The text to encode.

  • src: string,
    dest: Uint8Array

    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);
    @param src

    The text to encode.

    @param dest

    The array to hold the encode result.