unicode-strings

About

The unicode-strings module was written to make transforming strings from Unicode to ASCII simpler. This transformation may come in useful when trying to use strings with systems that aren't compatible with the extended Unicode character set.

1. Installation

npm install git+https://github.com/cbroad/unicode-strings.git

2. Importing

ES6 Syntax

import * as UnicodeStrings from "unicode-strings"
// Alternatively
import { escapeString, unescapeString } from "unicode-strings"

CommonJS Syntax

const UnicodeStrings = require( "unicode-strings" );
// Alternatively
const { escapeString, unescapeString } = require( "unicode-strings" );

3. Usage

const asciiString = UnicodeStrings.escapeString("Good Morning! おはようございます 🐡");
console.log( asciiString );
// Good Morning! \u304a\u306f\u3088\u3046\u3054\u3056\u3044\u307e\u3059 \ud83d\udc21
const unicodeString = unescapeString("Good Morning! \\u304a\\u306f\\u3088\\u3046\\u3054\\u3056\\u3044\\u307e\\u3059 \\ud83d\\udc21");
console.log( unicodeString );
// Good Morning! おはようございます 🐡

API

Function	Description
UnicodeStrings.escapeString()	Blah
UnicodeStrings.unescapeString()	Blah
UnicodeStrings.unicodeEscapeString()	Blah

UnicodeStrings.escapeString( str )

Transforms a string. Any unicode characters will be backslash-escaped using the method producing the shortest length possible.

Escape characters encoded include:

• "\b", "\f", "\n", "\r", "\t", "\v"
• "\oo" - 2-digit octal-value for characters with value<0x20
• "\xXX" - 2-digit hex-value for characters with value such that 0x80<=value<=0xff
• "\uXXXX" - 4-digit hex-value for characters with value such that 0x100<=value<=0xffff

str	a string possibly containing unicode characters
returns	encoded string

UnicodeStrings.unescapeString( str )

Transforms a string. Any escape sequences will be converted to their character equivalents.

Escape characters decoded include:

• "\b", "\f", "\n", "\r", "\t", "\v"
• "\oo" - 2-digit octal-value for characters with value<0x20
• "\xXX" - 2-digit hex-value for characters with value such that 0x80<=value<=0xff
• "\uXXXX" - 4-digit hex-value for characters with value such that 0x100<=value<=0xffff

str	a string possibly containing escaped characters
returns	decoded string

UnicodeStrings.unicodeEscapeString( str )

Transforms a string. Only uses single character escape sequences and unicode escape sequences. This is useful because only these escape sequences are allowed in JSON formatted data.

Escape characters decoded include:

• "\b", "\f", "\n", "\r", "\t", "\v"
• "\uXXXX" - 4-digit hex-value for characters with value not in the range that 0x20<=value<0x80

str	a string possibly containing escaped characters
returns	decoded string