iso-8859-5

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:

<script src="iso-8859-5.js"></script>

In Node.js:

const iso88595 = require('iso-8859-5');

API

iso88595.version

A string representing the semantic version number.

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 a ‘byte string’, i.e. a string of which each item 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. For encoding, the error mode can be 'fatal' (the default) or 'html'.

const encodedData = iso88595.encode(text, {
  mode: 'html'
});
// If `text` contains a symbol that cannot be represented in iso-8859-5,
// instead of throwing an error, it will return an HTML entity for the symbol.

iso88595.decode(input, options)

This function takes a byte string (the input parameter) and decodes it according to 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.

For decoding a buffer (e.g. from fs.readFile) use buffer.toString('binary') to get the byte string which decode takes.

Notes

Similar modules for other single-byte legacy encodings are available.

Author

Mathias Bynens

License

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