iso-8859-15

iso-8859-15

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

This encoding is known under the following names: csisolatin9, iso-8859-15, iso8859-15, iso885915, iso_8859-15, and l9.

Installation

Via npm:

npm install iso-8859-15

In a browser:

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

In Node.js, io.js, Narwhal, and RingoJS:

var iso885915 = require('iso-8859-15');

In Rhino:

load('iso885915.js');

Using an AMD loader like RequireJS:

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

API

iso885915.version

A string representing the semantic version number.

iso885915.labels

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

iso885915.encode(input, options)

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

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

iso885915.decode(input, options)

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

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

Mathias Bynens

License

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