macintosh

macintosh

macintosh is a robust JavaScript implementation of the macintosh character encoding as defined by the Encoding Standard.

This encoding is known under the following names: csmacintosh, mac, macintosh, and x-mac-roman.

Installation

Via npm:

npm install macintosh

In a browser:

<script src="macintosh.js"></script>

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

var macintosh = require('macintosh');

In Rhino:

load('macintosh.js');

Using an AMD loader like RequireJS:

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

API

macintosh.version

A string representing the semantic version number.

macintosh.labels

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

macintosh.encode(input, options)

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

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

macintosh.decode(input, options)

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

const text = macintosh.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 = macintosh.decode(encodedData, {
  'mode': 'fatal'
});
// If `encodedData` contains an invalid byte for the macintosh 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

macintosh 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

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

Author

Mathias Bynens

License

macintosh is available under the MIT license.