The fast-text-encoding npm package is a polyfill for the TextEncoder and TextDecoder APIs, which are part of the Encoding Living Standard. These APIs provide a straightforward way to encode and decode text using various character encodings, primarily UTF-8. This package is particularly useful in environments where the native TextEncoder and TextDecoder are not available, such as older browsers or specific Node.js versions.

What are fast-text-encoding's main functionalities?

Text Encoding

This feature allows you to encode a JavaScript string into a Uint8Array of bytes using UTF-8 encoding. It's useful for preparing text data for transmission or storage in binary formats.

const textEncoder = new TextEncoder();
const encoded = textEncoder.encode('Hello, World!');
console.log(encoded);

Text Decoding

This feature enables you to decode a Uint8Array of bytes into a JavaScript string using UTF-8 or other supported encodings. It's commonly used for reading text data received in binary format.

const textDecoder = new TextDecoder();
const decoded = textDecoder.decode(new Uint8Array([72, 101, 108, 108, 111]));
console.log(decoded);

Other packages similar to fast-text-encoding

Readme

Source

This is a fast polyfill for TextEncoder and TextDecoder, which let you encode and decode JavaScript strings into UTF-8 bytes.

It is fast partially as it does not support any encodings aside UTF-8 (and note that natively, only TextDecoder supports alternative encodings anyway).

Usage

Include the minified inside a script tag or as an ES6 Module for its side-effects. It will create TextEncoder and TextDecoder if the symbols are missing on window.

<script src="node_modules/fast-text-encoding/text.min.js"></script>
<script type="module">
  import './node_modules/fast-text-encoding/text.min.js';
  // confidently do something with TextEncoder \o/
</script>

Note: Always include text.min.js, as it's compiled to ES5 for older environments.

Node

Install via NPM or Yarn (name "fast-text-encoding"), and then import purely for side effects:

// don't need to save this anywhere, just require before use
require('fast-text-encoding');

const buffer = new TextEncoder().encode('Turn me into UTF-8!');
// buffer is now a Uint8Array of [84, 117, 114, 110, ...]

Supports

Built for IE11, Edge and Node environments. Not required for Chrome, Firefox etc, which have native implementations.

Release

Compile code with Closure Compiler.

// ==ClosureCompiler==
// @compilation_level ADVANCED_OPTIMIZATIONS
// @output_file_name text.min.js
// ==/ClosureCompiler==

// code here

FAQs

What is fast-text-encoding?

Is fast-text-encoding popular?

Is fast-text-encoding well maintained?

Package last updated on 01 Sep 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install