iso-8859-6

A robust iso-8859-6 encoder/decoder written in JavaScript.

iso-8859-6

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

This encoding is known under the following names: arabic, asmo-708, csiso88596e, csiso88596i, csisolatinarabic, ecma-114, iso-8859-6, iso-8859-6-e, iso-8859-6-i, iso-ir-127, iso8859-6, iso88596, iso_8859-6, and iso_8859-6:1987.

Via npm:

npm install iso-8859-6

Via Bower:

bower install iso-8859-6

Via Component:

component install mathiasbynens/iso-8859-6

In a browser:

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

In Narwhal, Node.js, and RingoJS:

var iso88596 = require('iso-8859-6');

In Rhino:

load('iso88596.js');

Using an AMD loader like RequireJS:

require(
  {
    'paths': {
      'iso-8859-6': 'path/to/iso-8859-6'
    }
  },
  ['iso-8859-6'],
  function(iso88596) {
    console.log(iso88596);
  }
);

A string representing the semantic version number.

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

This function takes a plain text string (the input parameter) and encodes it according to iso-8859-6. The return value is a ‘byte string’, i.e. a string of which each item represents an octet as per iso-8859-6.

var encodedData = iso88596.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 = iso88596.encode(text, {
  'mode': 'html'
});
// If `text` contains a symbol that cannot be represented in iso-8859-6, 
// instead of throwing an error, it will return an HTML entity for the symbol. 

This function takes a byte string (the input parameter) and decodes it according to iso-8859-6.

var text = iso88596.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 = iso88596.decode(encodedData, {
  'mode': 'fatal'
});
// If `encodedData` contains an invalid byte for the iso-8859-6 encoding, 
// instead of replacing it with U+FFFD in the output, an error is thrown. 

iso-8859-6 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.

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.

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

Mathias Bynens

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