text-decoding
v1.0.0
Published
[fork] TextEncoder and TextDecoder (Polyfill for the Encoding Living Standard's API) For Node.JS.
Downloads
3,605,078
Maintainers
Readme
text-decoding
text-decoding
is a fork of Polyfill for the Encoding Living Standard's API (text-encoding
) For Node.JS.
This is a polyfill for the Encoding Living Standard API for the Web, allowing encoding and decoding of textual data to and from Typed Array buffers for binary data in JavaScript.
By default it adheres to the spec and does not support encoding to legacy encodings, only decoding. It is also implemented to match the specification's algorithms, rather than for performance.
yarn add text-decoding
Table Of Contents
- Table Of Contents
- API
class TextDecoder
class TextEncoder
const EncodingIndexes
getEncoding(label: string): { name: string, labels: Array<string> }
- Encodings
- Copyright
API
The package is available by importing its named classes and functions:
import { TextEncoder, TextDecoder, EncodingIndexes, getEncoding } from 'text-decoding'
class TextDecoder
Decodes a Uint8Array into a string.
import { TextDecoder } from 'text-decoding'
const decoded = new TextDecoder('utf-8')
.decode(new Uint8Array([
0x7A, 0xC2, 0xA2, 0xE6, 0xB0, 0xB4, 0xF0,
0x9D, 0x84, 0x9E, 0xF4, 0x8F, 0xBF, 0xBD,
]))
console.log(decoded)
z¢水𝄞
class TextEncoder
Encodes a string into Uint8Array
for the given encoding.
As required by the specification, only encoding to utf-8 is supported. If you want to try it out, you can force a non-standard behavior by passing the NONSTANDARD_allowLegacyEncoding
option to TextEncoder and a label. For example:
import { TextEncoder } from 'text-decoding'
const uint8array = new TextEncoder(
'windows-1252', { NONSTANDARD_allowLegacyEncoding: true })
.encode('hello world')
console.log(uint8array)
Uint8Array [ 104, 101, 108, 108, 111, 32, 119, 111, 114, 108, 100 ]
const EncodingIndexes
This is a map of indexes used for encoding.
getEncoding(
label: string,
): { name: string, labels: Array<string> }
Returns the normalised name of the encoding and its associated labels.
import { getEncoding } from 'text-decoding'
const encoding = getEncoding('ascii')
console.log(encoding)
{ labels:
[ 'ansi_x3.4-1968',
'ascii',
'cp1252',
'cp819',
'csisolatin1',
'ibm819',
'iso-8859-1',
'iso-ir-100',
'iso8859-1',
'iso88591',
'iso_8859-1',
'iso_8859-1:1987',
'l1',
'latin1',
'us-ascii',
'windows-1252',
'x-cp1252' ],
name: 'windows-1252' }
Encodings
All encodings from the Encoding specification are supported:
utf-8 ibm866 iso-8859-2 iso-8859-3 iso-8859-4 iso-8859-5 iso-8859-6 iso-8859-7 iso-8859-8 iso-8859-8-i iso-8859-10 iso-8859-13 iso-8859-14 iso-8859-15 iso-8859-16 koi8-r koi8-u macintosh windows-874 windows-1250 windows-1251 windows-1252 windows-1253 windows-1254 windows-1255 windows-1256 windows-1257 windows-1258 x-mac-cyrillic gb18030 hz-gb-2312 big5 euc-jp iso-2022-jp shift_jis euc-kr replacement utf-16be utf-16le x-user-defined
(Some encodings may be supported under other names, e.g. ascii, iso-8859-1, etc. See Encoding for additional labels for each encoding.)
Copyright
Original Work By Joshua Bell under dual Unlicense/Apache-2.0 license.
The encoding indexes, algorithms, and many comments in the code derive from the Encoding Standard https://encoding.spec.whatwg.org/