# text-encoding-shim

> Simple lightweight polyfill for the Text Encoding API, supporting UTF-8 only

Latest version **1.0.5** (published 2019-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install text-encoding-shim
pnpm add text-encoding-shim
yarn add text-encoding-shim
bun add text-encoding-shim
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2019-12-21 |
| First published | 2016-09-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Till Affeldt |
| Maintainers | pseudopsycho |
| Keywords | encoding, decoding, w3c, utf-8 |

## Links

- npm: https://www.npmjs.com/package/text-encoding-shim
- Repository: https://gitlab.com/PseudoPsycho/text-encoding-shim
- Issues: https://gitlab.com/PseudoPsycho/text-encoding-shim/issues
- npm.io page: https://npm.io/package/text-encoding-shim

## 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

- 1.0.5 (latest) — 2019-12-21
- 1.0.4 — 2019-07-23
- 1.0.3 — 2019-02-24
- 1.0.0 — 2016-09-07

## README

# Text Encoding Shim
When I was looking for a simple lightweight polyfill that works great with TypeScript I was not happy with the results.
While a couple polyfills exist, they either broke in my special setup and lead to unexpected results or they implemented a bunch
of features that I did not even want to have. So I wrote my own shim.

## Installation
### npm
Get it via *npm* by adding `text-encoding-shim` to your `package.json` or run:
```shell
npm install text-encoding-shim
```

### Bower
Get it via *Bower* by adding it to your `bower.json` or run:
```shell
bower install --save text-encoding-shim
```

### HTML script tag
Altenatively you can simply download this project folder from [Gitlab](https://gitlab.com/PseudoPsycho/text-encoding-shim)
and add it to your html script tags like so:
```shell
<script type="text/javascript" src="text-encoding-shim/index.js"></script>
```

### TypeScript definitions
If you are using TypeScript you do not need to create a definition file. This project already includes one.
If you are still using *typings* you may need to run this command to copy the file:
```shell
typings install --save --global npm:text-encoding-shim
```

## Importing the polyfill
This polyfill utilizes the Universal Module Definition (UMD) and be used with either a module loader or standalone.
If you import it by adding a script tag you do not have to do anything else. It will automatically be bound to the global scope.
### CommonJS
```js
var TextEncodingShim = require('text-encoding-shim');
var TextEncoder = TextEncodingShim.TextEncoder;
var TextDecoder = TextEncodingShim.TextDecoder;
```

### Asynchronous Module Definition (AMD)
```js
define([TextEncodingShim], function() {
	//...
});
```

### ES2015 or TypeScript
```js
import { TextEncoder, TextDecoder } from 'text-encoding-shim';
```

## Basic Usage
```js
var uint8array = new TextEncoder('utf-8').encode(string);
var string = new TextDecoder('utf-8').decode(uint8array);
```

## Limitations
If a native implementation is available it will always be handled preferred to this polyfill.
Just like native implementations of Mozilla Firefox or Google Chrome, this library only supports UTF-8 encoding.
This makes it so fast. If you need additional encodings, check out [this more advanced polyfill](https://github.com/inexorabletash/text-encoding).

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