Package Exports

x-mac-cyrillic

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 (x-mac-cyrillic) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

x-mac-cyrillic

x-mac-cyrillic is a robust JavaScript implementation of the x-mac-cyrillic character encoding as defined by the Encoding Standard.

This encoding is known under the following names: x-mac-cyrillic, and x-mac-ukrainian.

Installation

Via npm:

npm install x-mac-cyrillic

Via Bower:

bower install x-mac-cyrillic

Via Component:

component install mathiasbynens/x-mac-cyrillic

In a browser:

<script src="x-mac-cyrillic.js"></script>

In Narwhal, Node.js, and RingoJS:

var xmaccyrillic = require('x-mac-cyrillic');

In Rhino:

load('xmaccyrillic.js');

Using an AMD loader like RequireJS:

require(
  {
    'paths': {
      'x-mac-cyrillic': 'path/to/x-mac-cyrillic'
    }
  },
  ['x-mac-cyrillic'],
  function(xmaccyrillic) {
    console.log(xmaccyrillic);
  }
);

API

`xmaccyrillic.version`

A string representing the semantic version number.

`xmaccyrillic.labels`

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

`xmaccyrillic.encode(input, options)`

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

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

`xmaccyrillic.decode(input, options)`

This function takes a byte string (the input parameter) and decodes it according to x-mac-cyrillic.

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

Support

x-mac-cyrillic 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.

Notes

Author


Mathias Bynens

License

x-mac-cyrillic is available under the MIT license.