This Javascript library provides the most performant tiny polyfill for window.TextEncoder
and window.TextDecoder
for use in the browser, in NodeJS, in RequireJS, in web Workers, in SharedWorkers, and in ServiceWorkers.
Quick Start
Add the following HTML Code inside the <head>
:
<script src="https://dl.dropboxusercontent.com/s/r55397ld512etib/EncoderDecoderTogether.min.js?dl=0" nomodule="" type="text/javascript"></script>
If no script on the page requires this library until the DOMContentLoaded event, then use the the much less blocking version below:
<script defer="" src="https://dl.dropboxusercontent.com/s/r55397ld512etib/EncoderDecoderTogether.min.js?dl=0" nomodule="" type="text/javascript"></script>
Alternatively, either use https://dl.dropboxusercontent.com/s/47481btie8pb95h/FastestTextEncoderPolyfill.min.js?dl=0
to polyfill window.TextEncoder
for converting a String
into a Uint8Array
or use https://dl.dropboxusercontent.com/s/qmoknmp86sytc74/FastestTextDecoderPolyfill.min.js?dl=0
to only polyfill window.TextDecoder
for converting a Uint8Array
/ArrayBuffer
/[typedarray]/global.Buffer
into a String
.
The nomodule
attribute prevents the script from being needlessly downloaded and executed on browsers which already support TextEncoder
and TextDecoder
. nomodule
does not test for the presence of TextEncoder
or TextDecoder
, but it is very safe to assume that browsers advanced enough to support modules also support TextEncoder
and TextDecoder
.
RequireJS and NodeJS
For dropping into either RequireJS or NodeJS, please use the fastestsmallesttextencoderdecoder
npm repository, this minified file, or the corresponding source code file. To install via npm, use the following code,
npm install fastestsmallesttextencoderdecoder
AngularJS
Open a terminal in the project's directory, and install fastestsmallesttextencoderdecoder via npm.
npm install fastestsmallesttextencoderdecoder
Then, add import 'fastestsmallesttextencoderdecoder';
to the polyfills.ts file.
Browser Support
This polyfill will bring
support for TextEncoder/TextDecoder to the following browsers.
Also note that while this polyfill may work in these old browsers, it is very likely that the rest of one's website will not unless if one make a concious effort to have their code work in these old browsers.
* Partial polyfill means that Array
(or Buffer
in NodeJS) will be used instead of Uint8Array
/[typedarray].
** This is the first public release of the browser
API Documentation
Please review the MDN at window.TextEncoder
and window.TextDecoder
for information on how to use TextEncoder and TextDecoder.
As for NodeJS, calling require("EncoderAndDecoderNodeJS.min.js")
yields the following object. Note that this polyfill checks for global.TextEncoder
and global.TextDecoder
and returns the native implementation if available.
module.exports = {
TextEncoder: function TextEncoder(){},
TextDecoder: function TextDecoder(){},
encode: TextEncoder.prototype.encode,
decode: TextDecoder.prototype.decode
}
In NodeJS, one does not ever have to use new
just to get the encoder/decoder (although one still can do so if they want to). All of the code snippets below function identically (aside from unused local variables introduced into the scope).
const {TextEncoder, TextDecoder} = require("fastestsmallesttextencoderdecoder");
const encode = (new TextEncoder).encode;
const decode = (new TextDecoder).decode;
const {encode, decode} = require("fastestsmallesttextencoderdecoder");
const encodeAndDecodeModule = require("fastestsmallesttextencoderdecoder");
const encode = encodeAndDecodeModule.encode;
const decode = encodeAndDecodeModule.decode;
Or, one can use the new and shiny ES6 module importation statements.
import {TextEncoder, TextDecoder} from "fastestsmallesttextencoderdecoder";
const encode = (new TextEncoder).encode;
const decode = (new TextDecoder).decode;
import {encode, decode} from "fastestsmallesttextencoderdecoder";
import * as encodeAndDecodeModule from "fastestsmallesttextencoderdecoder";
const encode = encodeAndDecodeModule.encode;
const decode = encodeAndDecodeModule.decode;
Note that fastestsmallesttextencoderdecoder must be installed via the following snippet in the terminal in order for the require("fastestsmallesttextencoderdecoder")
to work.
npm install fastestsmallesttextencoderdecoder
Demonstration
Visit the GithubPage to see a demonstation. As seen in the Web Worker hexWorker.js, the Github Pages demonstration uses a special encoderAndDecoderForced.src.js version of this library to forcefully install the TextEncoder and TextDecoder even when there is native support. That way, this demonstraton should serve to truthfully demonstrate this polyfill.
npm Project
This project can be found on npm here at this link.
Development
On linux, the project can be developed by cloning it with the following command line.
git clone https://github.com/anonyco/FastestSmallestTextEncoderDecoder.git; cd FastestSmallestTextEncoderDecoder; npm run install-dev
Emphasize the npm run install-dev
which downloads closure-compiler.jar
into the repository for minifying the files.
Now that the repository is cloned, edit the files as one see fit. Now that the files have been edited, run the following in the terminal in the root folder of the repository in order to minify the NodeJS JavaScript files.
npm run build