TextEncoder

TextEncoder takes a stream of code points as input and emits a stream of bytes. For a more scalable, non-native library, see StringView – a C-like representation of strings based on typed arrays.

Note: Firefox, Chrome and Opera had support for encoding types other than utf-8 (such as: utf-16, iso-8859-2, koi8, cp1261, and gbk). As of Firebox 48 (ticket), Chrome 54 (ticket) and Opera 41, no other encoding types are available other than utf-8, in order to match the spec. In all cases, passing in an encoding type to the constructor will be ignored and a utf-8 TextEncoder will be created (Note: the TextDecoder still allows for other decoding types).

There is a polyfill implementation to support all the legacy encoding in github.

Properties

The TextEncoder interface doesn't inherit any property.

TextEncoder.encoding Read only

Is a DOMString containing the name of the encoder, that is a string describing the method the TextEncoder will use.

Constructor

TextEncoder()

Returns a newly constructed TextEncoder that will generate a byte stream with utf-8 encoding.

Methods

The TextEncoder interface doesn't inherit any method.

TextEncoder.encode()

Returns a Uint8Array containing utf-8 encoded text.

Specifications

Specification	Status	Comment
Encoding The definition of 'TextEncoder' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

[1] An earlier, and slightly different, version of the specification was implemented in Firefox 18.
[2] As of Firefox 48, Chrome 54 and Opera 41, no other encoding types are allowed other than utf-8.

See also

• The TextDecoder interface describing the inverse operation.
• StringView – a C-like representation of strings based on typed arrays
• A shim allowing to use this interface in browsers that don't support it.
• Components.utils.importGlobalProperties