README.md

iso-8859-5

iso-8859-5 is a robust JavaScript implementation of the iso-8859-5 character encoding as defined by the Encoding Standard.

This encoding is known under the following names: csisolatincyrillic, cyrillic, iso-8859-5, iso-ir-144, iso8859-5, iso88595, iso_8859-5, and iso_8859-5:1988.

Installation

Via npm:

npm install iso-8859-5

In a browser or in Node.js:

import {encode, decode, labels} from 'iso-8859-5';
// or…
import * as iso88595 from 'iso-8859-5';

API

iso88595.labels

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

iso88595.encode(input, options)

This function takes a plain text string (the input parameter) and encodes it according to iso-8859-5. The return value is an environment-agnostic Uint16Array of which each element represents an octet as per iso-8859-5.

const encodedData = iso88595.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 = iso88595.encode(text, {
  mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in iso-8859-5,
// instead of throwing an error, it becomes 0xFFFD.

iso88595.decode(input, options)

This function decodes input according to iso-8859-5. The input parameter can either be a Uint16Array of which each element represents an octet as per iso-8859-5, or a ‘byte string’ (i.e. a string of which each item represents an octet as per iso-8859-5).

const text = iso88595.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 = iso88595.decode(encodedData, {
  mode: 'fatal'
});
// If `encodedData` contains an invalid byte for the iso-8859-5 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

iso-8859-5 is available under the MIT license.