tr46

What is tr46?

The tr46 npm package is a JavaScript implementation of the TR46 algorithm, which is used for processing internationalized domain names (IDNs) and internationalized email addresses. It provides functionality to convert Unicode strings to ASCII strings that conform to the IDNA (Internationalized Domain Names in Applications) standards, and vice versa. This is useful for applications that need to handle domain names containing non-ASCII characters.

What are tr46's main functionalities?

toASCII

Converts a Unicode domain name to an ASCII Compatible Encoding (ACE), following the IDNA standards. This is useful for domain name resolution in environments that only support ASCII.

const tr46 = require('tr46');
const result = tr46.toASCII('täst.com');
console.log(result); // 'xn--tst-qla.com'

toUnicode

Converts an ASCII Compatible Encoding (ACE) domain name back to its Unicode form. This is useful for displaying domain names to users in their native script.

const tr46 = require('tr46');
const result = tr46.toUnicode('xn--tst-qla.com');
console.log(result); // 'täst.com'

processing options

Provides additional processing options for toASCII and toUnicode functions, such as checking for proper use of hyphens, bidirectional characters, and joiners, as well as using STD3 ASCII rules and choosing between transitional or non-transitional processing.

const tr46 = require('tr46');
const result = tr46.toASCII('täst.com', {checkHyphens: true, checkBidi: true, checkJoiners: true, useSTD3ASCIIRules: true, processingOption: 'TRANSITIONAL'});
console.log(result); // 'xn--tst-qla.com'

Other packages similar to tr46

punycode

Punycode.js is a robust Punycode converter that fully complies with RFC 3492 and RFC 5891, and works on nearly all JavaScript platforms. This package is used to convert Unicode strings to Punycode and vice versa, similar to tr46's toASCII and toUnicode functions. However, tr46 provides additional processing options and is designed to comply with the TR46 algorithm.

idna-uts46

The idna-uts46 package is a small library that converts a Unicode string to an ASCII string as per the IDNA2008 (UTS #46) standard. It is similar to tr46 in that it handles internationalized domain names, but it may have different API options and compliance specifics.

README

tr46

An JavaScript implementation of Unicode Technical Standard #46: Unicode IDNA Compatibility Processing.

Installation

Node.js ≥ 12 is required. To install, type this at the command line:

npm install tr46
# or
yarn add tr46

API

toASCII(domainName[, options])

Converts a string of Unicode symbols to a case-folded Punycode string of ASCII symbols.

Available options:

• checkBidi
• checkHyphens
• checkJoiners
• processingOption
• useSTD3ASCIIRules
• verifyDNSLength

toUnicode(domainName[, options])

Converts a case-folded Punycode string of ASCII symbols to a string of Unicode symbols.

Available options:

• checkBidi
• checkHyphens
• checkJoiners
• processingOption
• useSTD3ASCIIRules

Options

checkBidi

Type: boolean Default value: false When set to true, any bi-directional text within the input will be checked for validation.

checkHyphens

Type: boolean Default value: false When set to true, the positions of any hyphen characters within the input will be checked for validation.

checkJoiners

Type: boolean Default value: false When set to true, any word joiner characters within the input will be checked for validation.

processingOption

Type: string Default value: "nontransitional" When set to "transitional", symbols within the input will be validated according to the older IDNA2003 protocol. When set to "nontransitional", the current IDNA2008 protocol will be used.

useSTD3ASCIIRules

Type: boolean Default value: false When set to true, input will be validated according to STD3 Rules.

verifyDNSLength

Type: boolean Default value: false When set to true, the length of each DNS label within the input will be checked for validation.