Skip to content
A robust JavaScript implementation of the windows-1251 character encoding as defined by the Encoding Standard.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data
scripts Update dependencies May 31, 2016
src Update test environments Jan 25, 2016
tests package.json: Add `legacy-encoding` keyword May 15, 2014
.gitattributes Initial release May 6, 2014
.gitignore
.travis.yml Update dependencies May 31, 2016
Gruntfile.js
LICENSE-MIT.txt Update dependencies Sep 2, 2014
README.md Clean up some files Jul 15, 2016
package.json
windows-1251.js

README.md

windows-1251 Build status Code coverage status Dependency status

windows-1251 is a robust JavaScript implementation of the windows-1251 character encoding as defined by the Encoding Standard.

This encoding is known under the following names: cp1251, windows-1251, and x-cp1251.

Installation

Via npm:

npm install windows-1251

In a browser:

<script src="windows-1251.js"></script>

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

var windows1251 = require('windows-1251');

In Rhino:

load('windows1251.js');

Using an AMD loader like RequireJS:

require(
  {
    'paths': {
      'windows-1251': 'path/to/windows-1251'
    }
  },
  ['windows-1251'],
  function(windows1251) {
    console.log(windows1251);
  }
);

API

windows1251.version

A string representing the semantic version number.

windows1251.labels

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

windows1251.encode(input, options)

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

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

windows1251.decode(input, options)

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

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

windows-1251 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

twitter/mathias
Mathias Bynens

License

windows-1251 is available under the MIT license.

You can’t perform that action at this time.