single-byte v1.0.7

single-byte

Transforms for single-byte encodings.

Implementation has no dependencies and is based on precomputed indexes for various encodings based on specification provided by the Web Hypertext Application Technology Working Group (WHATWG).

Installation

npm install --save single-byte

Usage example

Any environment

const { encode, decode } = require('single-byte');

const buffer = encode('iso-8859-2', 'zażółć gęślą jaźń');
console.log(decode('iso-8859-2', buffer));

Environment supporting Node.js stream API

const fs = require('fs');
const { Encoder } = require('single-byte/stream');

fs.createReadStream('file-utf8.txt')
  .pipe(new Encoder('iso-8859-2'))
  .pipe(fs.createWriteStream('file-iso-8859-2.txt'));

API

Table of Contents

• UTILITIES
• encode
• decode
• STREAMS
• Encoder
  • setSingleByteEncoding
• Decoder
  • setSingleByteEncoding
• SUPPORTED ENCODINGS

UTILITIES

Basic functions.

encode

Parameters

• label string
• text string

Returns Buffer

decode

Parameters

• label string
• buffer Buffer

Returns string

STREAMS

Note: stream must be present in the global namespace.

Encoder

Extends stream.Transform

Parameters

• encoding string
• options any

setSingleByteEncoding

Parameters

• encoding string

Decoder

Extends stream.Transform

Parameters

• encoding string
• options any

setSingleByteEncoding

Parameters

• encoding string

SUPPORTED ENCODINGS