Package Exports

koi8-u

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (koi8-u) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

koi8-u

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

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

Installation

Via npm:

npm install koi8-u

In a browser:

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

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

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

In Rhino:

load('koi8u.js');

Using an AMD loader like RequireJS:

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

API

`koi8u.version`

A string representing the semantic version number.

`koi8u.labels`

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

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

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

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

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

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

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

Support

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

Author


Mathias Bynens

License

koi8-u is available under the MIT license.