windows-874

windows-874

windows-874 is robust JavaScript implementation of the windows-874 character encoding as defined by the Encoding Standard.

This encoding is known under the following names: dos-874, iso-8859-11, iso8859-11, iso885911, tis-620, windows-874, and windows-874.

Installation

Via npm:

npm install windows-874

Via Bower:

bower install windows-874

Via Component:

component install mathiasbynens/windows-874

In a browser:

<script src="windows-874.js"></script>

In Narwhal, Node.js, and RingoJS:

var windows874 = require('windows-874');

In Rhino:

load('windows874.js');

Using an AMD loader like RequireJS:

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

API

windows874.version

A string representing the semantic version number.

windows874.encode(input, options)

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

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

windows874.decode(input, options)

This function takes a byte string (the input parameter) and decodes it according to windows-874.

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

Support

windows-874 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

windows-874 is available under the MIT license.