# windows-1256

> A robust windows-1256 encoder/decoder written in JavaScript.

Latest version **3.0.4** (published 2021-12-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install windows-1256
pnpm add windows-1256
yarn add windows-1256
bun add windows-1256
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.4 |
| Published | 2021-12-09 |
| First published | 2014-05-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 12.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Mathias Bynens |
| Maintainers | mathias, google-wombot |
| Keywords | codec, decoder, decoding, encoder, encoding, legacy, legacy-encoding, cp1256, windows-1256, x-cp1256 |

## Links

- npm: https://www.npmjs.com/package/windows-1256
- Repository: https://github.com/mathiasbynens/windows-1256
- Homepage: https://mths.be/windows-1256
- Issues: https://github.com/mathiasbynens/windows-1256/issues
- npm.io page: https://npm.io/package/windows-1256

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 3.0.4 (latest) — 2021-12-09
- 3.0.3 — 2021-11-28
- 3.0.2 — 2021-09-05
- 3.0.1 — 2021-08-02
- 3.0.0 — 2021-07-30
- 2.0.0 — 2021-07-30
- 1.1.0 — 2021-07-30
- 1.0.2 — 2021-07-30
- 1.0.1 — 2021-07-30
- 1.0.0 — 2016-10-24
- 0.1.2 — 2014-05-15
- 0.1.1 — 2014-05-06
- 0.1.0 — 2014-05-06

## README

# windows-1256 [![Build status](https://github.com/mathiasbynens/windows-1256/workflows/run-checks/badge.svg)](https://github.com/mathiasbynens/windows-1256/actions?query=workflow%3Arun-checks) [![windows-1256 on npm](https://img.shields.io/npm/v/windows-1256)](https://www.npmjs.com/package/windows-1256)

_windows-1256_ is a robust JavaScript implementation of [the windows-1256 character encoding as defined by the Encoding Standard](https://encoding.spec.whatwg.org/#windows-1256).

This encoding is known under the following names: cp1256, windows-1256, and x-cp1256.

## Installation

Via [npm](https://www.npmjs.com/):

```bash
npm install windows-1256
```

In a browser or in [Node.js](https://nodejs.org/):

```js
import {encode, decode, labels} from 'windows-1256';
// or…
import * as windows1256 from 'windows-1256';
```

## API

### `windows1256.labels`

An array of strings, each representing a [label](https://encoding.spec.whatwg.org/#label) for this encoding.

### `windows1256.encode(input, options)`

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

```js
const encodedData = windows1256.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](https://encoding.spec.whatwg.org/#error-mode), 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.)

```js
const encodedData = windows1256.encode(text, {
  mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in windows-1256,
// instead of throwing an error, it becomes 0xFFFD.
```

### `windows1256.decode(input, options)`

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

```js
const text = windows1256.decode(encodedData);
```

The optional `options` object and its `mode` property can be used to set the [error mode](https://encoding.spec.whatwg.org/#error-mode). For decoding, the error mode can be `'replacement'` (the default) or `'fatal'`.

```js
const text = windows1256.decode(encodedData, {
  mode: 'fatal'
});
// If `encodedData` contains an invalid byte for the windows-1256 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.](https://www.npmjs.com/browse/keyword/legacy-encoding)

## Author

| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
|---|
| [Mathias Bynens](https://mathiasbynens.be/) |

## License

_windows-1256_ is available under the [MIT](https://mths.be/mit) license.

---
_Source: https://npm.io/package/windows-1256 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._