iso-8859-5

iso-8859-5

iso-8859-5 is 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, iso_8859-5:1988, and iso_8859-5:1988.

Installation

Via npm:

npm install iso-8859-5

Via Bower:

bower install iso-8859-5

Via Component:

component install mathiasbynens/iso-8859-5

In a browser:

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

In Narwhal, Node.js, and RingoJS:

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

In Rhino:

load('iso88595.js');

Using an AMD loader like RequireJS:

require(
  {
    'paths': {
      'iso88595': 'path/to/iso88595'
    }
  },
  ['iso88595'],
  function(iso88595) {
    console.log(iso88595);
  }
);

API

iso88595.version

A string representing the semantic version number.

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.

var 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'.

var 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.

var 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'.

var 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.

Support

iso-8859-5 is designed to work in at least Node.js v0.10.0, Narwhal 0.3.2, RingoJS 0.8-0.9, PhantomJS 1.9.0, Rhino 1.7RC4, as well as old and modern versions of Chrome, Firefox, Safari, Opera, and Internet Explorer.

Unit tests & code coverage

After cloning this repository, run npm install to install the dependencies needed for development and testing. You may want to install Istanbul globally using npm install istanbul -g.

Once that’s done, you can run the unit tests in Node using npm test or node tests/tests.js. To run the tests in Rhino, Ringo, Narwhal, and web browsers as well, use grunt test.

To generate the code coverage report, use grunt cover.

Author

Mathias Bynens

License

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