@kayahr/text-encoding v1.3.0

Text Encoding

GitHub | NPM | API Doc

This project is a heavily refactored clone of an old abandoned text-encoding library with the following changes:

• Refactored into a modern TypeScript project.
• Separated the monolithic script into many logical modules.
• Each encoding is a separate module and can be loaded individually if needed.
• No longer a polyfill for the Encoding API but a API compatible replacement with advanced features like encoding support for not just UTF-8.

Usage

Install the library as a dependency in your project:

npm install @kayahr/text-encoding

And then use it like this:

import { TextEncoder, TextDecoder } from "@kayahr/text-encoding";

const encoder = new TextEncoder("big5");
const encoded = encoder.encode(string);

const decoder = new TextDecoder("big5");
const decoded = decoder.decode(encoded);

When importing the module from @kayahr/text-encoding then all provided encodings are loaded automatically. If you want to keep your application as small as possible then you can import the module like this instead:

import { TextEncoder } from "@kayahr/text-encoding/no-encodings";

When doing this then no encodings are loaded and only UTF-8 is supported. When you later need a specific encoding then use imports like this:

import "@kayahr/text-encoding/encodings/shift_jis";

Or import all encodings:

import "@kayahr/text-encoding/encodings";

There is also a helper function for creating a text encoder which returns an implementation of the original TextEncoder (if present), when encoding is UTF-8 and an implementation of the custom TextEncoder from this library when encoding is not UTF-8:

import { createTextEncoder } from "@kayahr/text-encoding";

const encoder = createTextEncoder(encoding);

Supported encodings