https://github.com/mathiasbynens/koi8-r
A robust JavaScript implementation of the koi8-r character encoding as defined by the Encoding Standard.
https://github.com/mathiasbynens/koi8-r
Last synced: 2 months ago
JSON representation
A robust JavaScript implementation of the koi8-r character encoding as defined by the Encoding Standard.
- Host: GitHub
- URL: https://github.com/mathiasbynens/koi8-r
- Owner: mathiasbynens
- License: mit
- Created: 2014-05-06T12:56:14.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2021-12-09T14:19:04.000Z (over 3 years ago)
- Last Synced: 2025-04-12T09:54:39.058Z (2 months ago)
- Language: JavaScript
- Homepage: https://mths.be/koi8-r
- Size: 81.1 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT.txt
Awesome Lists containing this project
README
# koi8-r [](https://github.com/mathiasbynens/koi8-r/actions?query=workflow%3Arun-checks) [](https://www.npmjs.com/package/koi8-r)
_koi8-r_ is a robust JavaScript implementation of [the koi8-r character encoding as defined by the Encoding Standard](https://encoding.spec.whatwg.org/#koi8-r).
This encoding is known under the following names: cskoi8r, koi, koi8, koi8-r, and koi8_r.
## Installation
Via [npm](https://www.npmjs.com/):
```bash
npm install koi8-r
```
In a browser or in [Node.js](https://nodejs.org/):
```js
import {encode, decode, labels} from 'koi8-r';
// or…
import * as koi8r from 'koi8-r';
```
## API
### `koi8r.labels`
An array of strings, each representing a [label](https://encoding.spec.whatwg.org/#label) for this encoding.
### `koi8r.encode(input, options)`
This function takes a plain text string (the `input` parameter) and encodes it according to koi8-r. The return value is an environment-agnostic `Uint16Array` of which each element represents an octet as per koi8-r.
```js
const encodedData = koi8r.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 = koi8r.encode(text, {
mode: 'replacement'
});
// If `text` contains a symbol that cannot be represented in koi8-r,
// instead of throwing an error, it becomes 0xFFFD.
```
### `koi8r.decode(input, options)`
This function decodes `input` according to koi8-r. The `input` parameter can either be a `Uint16Array` of which each element represents an octet as per koi8-r, or a ‘byte string’ (i.e. a string of which each item represents an octet as per koi8-r).
```js
const text = koi8r.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 = koi8r.decode(encodedData, {
mode: 'fatal'
});
// If `encodedData` contains an invalid byte for the koi8-r 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
| [](https://twitter.com/mathias "Follow @mathias on Twitter") |
|---|
| [Mathias Bynens](https://mathiasbynens.be/) |
## License
_koi8-r_ is available under the [MIT](https://mths.be/mit) license.