node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »


windows-1255 Build status Code coverage status Dependency status

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

This encoding is known under the following names: cp1255, windows-1255, and x-cp1255.


Via npm:

npm install windows-1255

In a browser:

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

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

var windows1255 = require('windows-1255');

In Rhino:


Using an AMD loader like RequireJS:

    'paths': {
      'windows-1255': 'path/to/windows-1255'
  function(windows1255) {



A string representing the semantic version number.


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

windows1255.encode(input, options)

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

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

windows1255.decode(input, options)

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

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


windows-1255 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.


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


Mathias Bynens


windows-1255 is available under the MIT license.