utfx v1.0.1

utfx is a compact library to encode, decode and convert UTF8 / UTF16 in JavaScript using arbitrary sources and destinations through the use of successively called functions, basically eliminating memory overhead.

The standalone library is also capable of using binary strings and arrays (with the usual overhead) and provides polyfills for String.fromCodePoint and String#codePointAt.

API

encodeUTF8(src, dst)

Encodes UTF8 code points to UTF8 bytes.

decodeUTF8(src, dst)

Decodes UTF8 bytes to UTF8 code points.

UTF16toUTF8(src, dst)

Converts UTF16 characters to UTF8 code points.

UTF8toUTF16(src, dst)

Converts UTF8 code points to UTF16 characters.

encodeUTF16toUTF8(src, dst)

Converts and encodes UTF16 characters to UTF8 bytes.

decodeUTF8toUTF16(src, dst)

Decodes and converts UTF8 bytes to UTF16 characters.

assertByte(b)

Asserts a byte value.

assertCharCode(c)

Asserts an UTF16 char code.

assertCodePoint(cp)

Asserts an UTF8 code point.

calculateCodePoint(cp)

Calculates the byte length of an UTF8 code point.

calculateUTF8(src)

Calculates the number of UTF8 bytes required to store UTF8 code points.

calculateUTF16asUTF8(src)

Calculates the number of UTF8 code points respectively UTF8 bytes required to store UTF16 char codes.

arraySource(a)

Creates a source function for an array.

arrayDestination(a)

Creates a destination function for an array.

stringSource(s)

Creates a source function for a string.

stringDestination()

Creates a destination function for a string.

fromCodePoint(var_args)

A polyfill for String.fromCodePoint.

codePointAt(s, i)

A polyfill for String#codePointAt.

polyfill(override=)

Installs utfx as a polyfill for String.fromCodePoint and String#codePointAt if not implemented.

Usage

• node.js: npm install utfx

  var utfx = require("utfx");
  ...

• Browser: <script src="/path/to/utfx.min.js"></script>

  var utfx = dcodeIO.utfx;
  ...

• Require.js/AMD

  require.config({
      "paths": {
          "utfx": "/path/to/utfx.min.js"
      }
  });
  require(["utfx"], function(utfx) {
      ...
  }

Downloads

• Distributions

FAQ and examples

• Wiki

License

Apache License, Version 2.0