x-mac-cyrillic

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

In a browser or in Node.js:

import {encode, decode, labels} from 'x-mac-cyrillic';
// or…
import * as xmaccyrillic from 'x-mac-cyrillic';

API

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 an environment-agnostic Uint16Array of which each element represents an octet as per x-mac-cyrillic.

const encodedData = xmaccyrillic.encode(text);

The optional options object and its mode property can be used to set the error mode. The two available error modes are 'fatal' (the default) or 'replacement'. (Note: This differs from the spec, which recognizes “fatal” and HTML” modes for encoders. The reason behind this difference is that the spec algorithm is aimed at producing HTML, whereas this library encodes into an environment-agnostic Uint16Array of bytes.)

const encodedData = xmaccyrillic.encode(text, {
  mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in x-mac-cyrillic,
// instead of throwing an error, it becomes 0xFFFD.

xmaccyrillic.decode(input, options)

This function decodes input according to x-mac-cyrillic. The input parameter can either be a Uint16Array of which each element represents an octet as per x-mac-cyrillic, or a ‘byte string’ (i.e. a string of which each item represents an octet as per x-mac-cyrillic).

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

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

Notes

Similar modules for other single-byte legacy encodings are available.

Author

Mathias Bynens

License

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