Contents

• Introduction
• Install
• Example
• Usage
• API
  • decode
  • encode
  • toUnicode
  • toASCII
  • ucs2Decode
  • ucs2Encode

Introduction

ESM/Typescript native version of punycode.js.

ESM native users / Typescript nodenext users may have some issues with the existing punycode library, so this hopefully serves as a viable alternative.

Logically this package should be the same as punycode.js. The only advantage of this library is ease-of-use for modern typescript/ESM.

Credit goes to Mathias Bynens for original implementation of this logic.

Install

1npm i punycode-esm

Example

1import { toASCII, toUnicode } from 'punycode-esm';
2
3// encode domain names
4toASCII('mañana.com'); // 'xn--maana-pta.com'
5toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
6
7// decode domain names
8toUnicode('xn--maana-pta.com'); // 'mañana.com'
9toUnicode('xn----dqo34k.com'); // '☃-⌘.com'

Usage

punycode-esm is an ESM module. That means it must be imported. To load from a CJS module, use dynamic import const { encode } = await import('punycode-esm');.

API

decode(string)

Converts a Punycode string of ASCII symbols to a string of Unicode symbols.

1// decode domain name parts
2Punycode.decode('maana-pta'); // 'mañana'
3Punycode.decode('--dqo34k'); // '☃-⌘'

encode(string)

Converts a string of Unicode symbols to a Punycode string of ASCII symbols.

1// encode domain name parts
2Punycode.encode('mañana'); // 'maana-pta'
3Punycode.encode('☃-⌘'); // '--dqo34k'

toUnicode(string)

Converts a Punycode string representing a domain name or an email address to Unicode. Only the Punycoded parts of the input will be converted, i.e. it doesn’t matter if you call it on a string that has already been converted to Unicode.

1// decode domain names
2Punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
3Punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
4
5// decode email addresses
6Punycode.toUnicode('джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'); // 'джумла@джpумлатест.bрфa'

toASCII(string)

Converts a lowercased Unicode string representing a domain name or an email address to Punycode. Only the non-ASCII parts of the input will be converted, i.e. it doesn’t matter if you call it with a domain that’s already in ASCII.

1Punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
2Punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
3
4// encode email addresses
5Punycode.toASCII('джумла@джpумлатест.bрфa'); // 'джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'

ucs2Decode(string)

Creates an array containing the numeric code point values of each Unicode symbol in the string. While JavaScript uses UCS-2 internally, this function will convert a pair of surrogate halves (each of which UCS-2 exposes as separate characters) into a single code point, matching UTF-16.

1ucs2Decode('abc'); // [0x61, 0x62, 0x63]
2// surrogate pair for U+1D306 TETRAGRAM FOR CENTRE:
3punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]

ucs2Encode(codePoints)

Creates a string based on an array of numeric code point values.

1punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
2punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'