Socket
Socket
Sign inDemoInstall

tr46

Package Overview
Dependencies
1
Maintainers
6
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

tr46

An implementation of the Unicode UTS #46: Unicode IDNA Compatibility Processing


Version published
Maintainers
6
Weekly downloads
60,658,059
decreased by-7.59%

Weekly downloads

Package description

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

Readme

Source

tr46

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

API

toASCII(domainName[, options])

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

Available options:

toUnicode(domainName[, options])

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

Available options:

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.

ignoreInvalidPunycode

Type: boolean Default value: false When set to true, invalid Punycode strings within the input will be allowed.

transitionalProcessing

Type: boolean Default value: false When set to true, uses transitional (compatibility) processing of the deviation characters.

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.

Keywords

FAQs

Last updated on 05 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc