windows-1255

A robust windows-1255 encoder/decoder written in JavaScript.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
windows-1255
3.0.42 years ago10 years agoMinified + gzip package size for windows-1255 in KB

Readme

windows-1255 Build status windows-1255 on npm
windows-1255 is a robust JavaScript implementation of the windows-1255 character encoding as defined by the Encoding Standard.
This encoding is known under the following names: cp1255, windows-1255, and x-cp1255.

Installation

Via npm:
npm install windows-1255

In a browser or in Node.js:
import {encode, decode, labels} from 'windows-1255';
// or…
import * as windows1255 from 'windows-1255';

API

windows1255.labels

An array of strings, each representing a label for this encoding.

windows1255.encode(input, options)

This function takes a plain text string (the input parameter) and encodes it according to windows-1255. The return value is an environment-agnostic Uint16Array of which each element represents an octet as per windows-1255.
const encodedData = windows1255.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 = windows1255.encode(text, {
  mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in windows-1255,
// instead of throwing an error, it becomes 0xFFFD.

windows1255.decode(input, options)

This function decodes input according to windows-1255. The input parameter can either be a Uint16Array of which each element represents an octet as per windows-1255, or a ‘byte string’ (i.e. a string of which each item represents an octet as per windows-1255).
const text = windows1255.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 = windows1255.decode(encodedData, {
  mode: 'fatal'
});
// If `encodedData` contains an invalid byte for the windows-1255 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

| twitter/mathias | |---| | Mathias Bynens |

License

windows-1255 is available under the MIT license.