Skip to main content
punycode - Node documentation

Usage in Deno

import * as mod from "node:punycode";
Deprecated

Since v7.0.0 - Deprecated

**The version of the punycode module bundled in Node.js is being deprecated. **In a future major version of Node.js this module will be removed. Users currently depending on the punycode module should switch to using the userland-provided Punycode.js module instead. For punycode-based URL encoding, see url.domainToASCII or, more generally, the WHATWG URL API.

The punycode module is a bundled version of the Punycode.js module. It can be accessed using:

import punycode from 'node:punycode';

Punycode is a character encoding scheme defined by RFC 3492 that is primarily intended for use in Internationalized Domain Names. Because host names in URLs are limited to ASCII characters only, Domain Names that contain non-ASCII characters must be converted into ASCII using the Punycode scheme. For instance, the Japanese character that translates into the English word, 'example' is '例'. The Internationalized Domain Name, '例.com' (equivalent to 'example.com') is represented by Punycode as the ASCII string 'xn--fsq.com'.

The punycode module provides a simple implementation of the Punycode standard.

The punycode module is a third-party dependency used by Node.js and made available to developers as a convenience. Fixes or other modifications to the module must be directed to the Punycode.js project.

Functions

f
decode

The punycode.decode() method converts a Punycode string of ASCII-onlycharacters to the equivalent string of Unicode codepoints.

f
encode

The punycode.encode() method converts a string of Unicode codepoints to a Punycode string of ASCII-only characters.

f
toASCII

The punycode.toASCII() method converts a Unicode string representing anInternationalized Domain Name to Punycode. Only the non-ASCII parts of thedomain name will be converted. Calling punycode.toASCII() on a string thatalready only contains ASCII characters will have no effect.

f
toUnicode

The punycode.toUnicode() method converts a string representing a domain namecontaining Punycode encoded characters into Unicode. Only the Punycode encoded parts of the domain name are beconverted.

Variables

I
v
ucs2
No documentation available
v
version
No documentation available