Documentation
Vip 05

VIP-05 --- JavaScript Encoding Capability

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in RFC 2119 (opens in a new tab).

draft optional

v-language:javascript

capability:Encoding

required-capability:Streams


1. Capability Description

The Encoding capability makes the functionality provided by the Encoding API (opens in a new tab) available.

The Streams capability is REQUIRED for some symbols defined by this capability to be available.

2. Available Symbols

The following table details what symbols are made available by this capability, and whether they require the Streams capability or not:

Symbol NameRequires Streams
TextDecoderNo
TextDecoder.TextDecoder()No
TextDecoder.encodingNo
TextDecoder.fatalNo
TextDecoder.ignoreBOMNo
TextDecoder.decode()No
TextEncoderNo
TextEncoder.TextEncoder()No
TextEncoder.prototype.encodingNo
TextEncoder.encode()No
TextEncoder.encodeInto()No
TextDecoderStreamYes
TextDecoderStream.TextDecoderStream()Yes
TextDecoderStream.encodingYes
TextDecoderStream.fatalYes
TextDecoderStream.ignoreBOMYes
TextDecoderStream.readableYes
TextDecoderStream.writableYes
TextEncoderStreamYes
TextEncoderStream.TextEncoderStream()Yes
TextEncoderStream.encodingYes
TextEncoderStream.readableYes
TextEncoderStream.writableYes
CompressionStreamYes
CompressionStream.CompressionStream()Yes
CompressionStream.readableYes
CompressionStream.writableYes
DecompressionStreamYes
DecompressionStream.DecompressionStream()Yes
DecompressionStream.readableYes
DecompressionStream.writableYes