Package Exports

ascii85

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

Readme

Ascii85 (Base85) Encoding/Decoding

Ascii85, also called Base85, is a form of binary-to-text encoding. By using five ASCII characters to represent four bytes of binary data, it is more efficient than uuencode or Base64, which use four characters to represent three bytes of data. See ascii85 wikipedia page for more details.

This node module can encode any binary string/buffer to an ascii85 string and decode an encoded string back to data.

Install

Install ascii85 through npm.

npm install --save ascii85

Usage

var ascii85 = require('ascii85');
var str = ascii85.encode('easy');

str === 'ARTY*';                // true
ascii85.decode(str) === 'easy'; // true

API

encode(data, [options])

Encode a binary data to ascii85 string.

data is a string or a Buffer.
options is optional. If it's provided, it can be an array of character or an option object.

See following sample for detail.

var ascii85 = require('ascii85');
var str;

// Most common use.
str = ascii85.encode('easy');

// Provide an array of charaters to encode the string.
// The array must have 85 elements. It's useful to work
// with a customized ascii85 encoding, e.g. ZeroMQ flavor.
str = ascii85.encode('easy', ['0', '1', '2', ...]);

str = ascii85.encode('easy', {
    table: [...],     // an array of characters to encode the string
    delimiter: false, // result will be sorrounded by '<~' and '~>'
    groupSpace: false // group spaces by 'u'
});

decode(str, [table])

Decode a string to binary string.

str is a string or a Buffer. All invalid characters will be discarded. If str starts with <~, it must have ~> at the end. Otherwise, an error will be thrown.
table is a sparse array to map char code to decoded value for decoding.

See following sample for detail.

var ascii85 = require('ascii85');
var data;

// Most common use.
data = ascii85.decode('ARTY*');

// Spaces can be omitted automatically.
data = ascii85.decode('A  R  T  Y  *');

// '<~' and '~>' can be trimmed properly.
data = ascii85.decode('<~ARTY*~>');

// Provide a sparse array to map char code to decode value.
ascii85.decode('ARTY*', [...]);

Ascii85(options)

Construct a new codec object. It can store customized options for every encode/decode.

var Ascii85 = require('ascii85').Ascii85;

// PostScript always uses delimiter.
var PostScript = new Ascii85({
    delimiter: true
});

PostScript.encode('easy') === '<~ARTY*~>'; // true

ZeroMQ

A specialized codec for ZeroMQ which uses different charset.

var ZeroMQ = require('ascii85').ZeroMQ;
ZeroMQ.encode('easy') === 'wNPU9'; // true

PostScript

A specialized codec for PostScript which always uses delimiter.

var PostScript = require('ascii85').PostScript;
PostScript.encode('easy') === '<~ARTY*~>'; // true

License

This module is licensed under the MIT license that can be found in the LICENSE file.