koi8-u

koi8-u

koi8-u is robust JavaScript implementation of the koi8-u character encoding as defined by the Encoding Standard.

This encoding is known under the following names: koi8-u, and koi8-u.

Installation

Via npm:

npm install koi8-u

Via Bower:

bower install koi8-u

Via Component:

component install mathiasbynens/koi8-u

In a browser:

<script src="koi8-u.js"></script>

In Narwhal, Node.js, and RingoJS:

var koi8u = require('koi8-u');

In Rhino:

load('koi8u.js');

Using an AMD loader like RequireJS:

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

API

koi8u.version

A string representing the semantic version number.

koi8u.encode(input, options)

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

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

koi8u.decode(input, options)

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

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

Support

koi8-u 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

koi8-u is available under the MIT license.