tr46

    2.1.0 • Public • Published

    tr46

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

    Installation

    Node.js ≥ 8 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:

    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.

    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.

    Install

    npm i tr46

    DownloadsWeekly Downloads

    16,291,353

    Version

    2.1.0

    License

    MIT

    Unpacked Size

    210 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar