node package manager

iso-8859-6

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

iso-8859-6 Build status Code coverage status Dependency status

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.

Installation

Via npm:

npm install iso-8859-6

In a browser:

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

In Node.js, io.js, Narwhal, 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);
  }
);

API

iso88596.version

A string representing the semantic version number.

iso88596.labels

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

iso88596.encode(input, options)

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.

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

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

iso88596.decode(input, options)

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

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

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

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

Support

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

Notes

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

Author

twitter/mathias
Mathias Bynens

License

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