windows-1257
v3.0.4
Published
A robust windows-1257 encoder/decoder written in JavaScript.
Downloads
37,626
Readme
windows-1257
windows-1257 is a robust JavaScript implementation of the windows-1257 character encoding as defined by the Encoding Standard.
This encoding is known under the following names: cp1257, windows-1257, and x-cp1257.
Installation
Via npm:
npm install windows-1257
In a browser or in Node.js:
import {encode, decode, labels} from 'windows-1257';
// or…
import * as windows1257 from 'windows-1257';
API
windows1257.labels
An array of strings, each representing a label for this encoding.
windows1257.encode(input, options)
This function takes a plain text string (the input
parameter) and encodes it according to windows-1257. The return value is an environment-agnostic Uint16Array
of which each element represents an octet as per windows-1257.
const encodedData = windows1257.encode(text);
The optional options
object and its mode
property can be used to set the error mode. The two available error modes are 'fatal'
(the default) or 'replacement'
. (Note: This differs from the spec, which recognizes “fatal” and HTML” modes for encoders. The reason behind this difference is that the spec algorithm is aimed at producing HTML, whereas this library encodes into an environment-agnostic Uint16Array
of bytes.)
const encodedData = windows1257.encode(text, {
mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in windows-1257,
// instead of throwing an error, it becomes 0xFFFD.
windows1257.decode(input, options)
This function decodes input
according to windows-1257. The input
parameter can either be a Uint16Array
of which each element represents an octet as per windows-1257, or a ‘byte string’ (i.e. a string of which each item represents an octet as per windows-1257).
const text = windows1257.decode(encodedData);
The optional options
object and its mode
property can be used to set the error mode. For decoding, the error mode can be 'replacement'
(the default) or 'fatal'
.
const text = windows1257.decode(encodedData, {
mode: 'fatal'
});
// If `encodedData` contains an invalid byte for the windows-1257 encoding,
// instead of replacing it with U+FFFD in the output, an error is thrown.
Notes
Similar modules for other single-byte legacy encodings are available.
Author
| | |---| | Mathias Bynens |
License
windows-1257 is available under the MIT license.