ibm866
TypeScript icon, indicating that this package has built-in type declarations

3.0.4 • Public • Published

ibm866 Build status ibm866 on npm

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

This encoding is known under the following names: 866, cp866, csibm866, and ibm866.

Installation

Via npm:

npm install ibm866

In a browser or in Node.js:

import {encode, decode, labels} from 'ibm866';
// or…
import * as ibm866 from 'ibm866';

API

ibm866.labels

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

ibm866.encode(input, options)

This function takes a plain text string (the input parameter) and encodes it according to ibm866. The return value is an environment-agnostic Uint16Array of which each element represents an octet as per ibm866.

const encodedData = ibm866.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 = ibm866.encode(text, {
  mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in ibm866,
// instead of throwing an error, it becomes 0xFFFD.

ibm866.decode(input, options)

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

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

twitter/mathias
Mathias Bynens

License

ibm866 is available under the MIT license.

Package Sidebar

Install

npm i ibm866

Weekly Downloads

115

Version

3.0.4

License

MIT

Unpacked Size

12.6 kB

Total Files

5

Last publish

Collaborators

  • mathias
  • google-wombot