tr46
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/tr46 package

5.0.0 • Public • Published

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.

Package Sidebar

Install

npm i tr46

Weekly Downloads

73,066,665

Version

5.0.0

License

MIT

Unpacked Size

221 kB

Total Files

7

Last publish

Collaborators

  • timothygu
  • domenic
  • sebmaster
  • zirro
  • tmpvar
  • joris-van-der-wel