diff options
| author | Adam Mathes <adam@adammathes.com> | 2026-02-13 21:34:48 -0800 |
|---|---|---|
| committer | Adam Mathes <adam@adammathes.com> | 2026-02-13 21:34:48 -0800 |
| commit | 76cb9c2a39d477a64824a985ade40507e3bbade1 (patch) | |
| tree | 41e997aa9c6f538d3a136af61dae9424db2005a9 /vanilla/node_modules/tr46/README.md | |
| parent | 819a39a21ac992b1393244a4c283bbb125208c69 (diff) | |
| download | neko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.gz neko-76cb9c2a39d477a64824a985ade40507e3bbade1.tar.bz2 neko-76cb9c2a39d477a64824a985ade40507e3bbade1.zip | |
feat(vanilla): add testing infrastructure and tests (NK-wjnczv)
Diffstat (limited to 'vanilla/node_modules/tr46/README.md')
| -rw-r--r-- | vanilla/node_modules/tr46/README.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/vanilla/node_modules/tr46/README.md b/vanilla/node_modules/tr46/README.md new file mode 100644 index 0000000..7bd9ffd --- /dev/null +++ b/vanilla/node_modules/tr46/README.md @@ -0,0 +1,76 @@ +# tr46 + +An JavaScript implementation of [Unicode Technical Standard #46: Unicode IDNA Compatibility Processing](https://unicode.org/reports/tr46/). + +## API + +### `toASCII(domainName[, options])` + +Converts a string of Unicode symbols to a case-folded Punycode string of ASCII symbols. + +Available options: + +* [`checkBidi`](#checkbidi) +* [`checkHyphens`](#checkhyphens) +* [`checkJoiners`](#checkjoiners) +* [`ignoreInvalidPunycode`](#ignoreinvalidpunycode) +* [`transitionalProcessing`](#transitionalprocessing) +* [`useSTD3ASCIIRules`](#usestd3asciirules) +* [`verifyDNSLength`](#verifydnslength) + +### `toUnicode(domainName[, options])` + +Converts a case-folded Punycode string of ASCII symbols to a string of Unicode symbols. + +Available options: + +* [`checkBidi`](#checkbidi) +* [`checkHyphens`](#checkhyphens) +* [`checkJoiners`](#checkjoiners) +* [`ignoreInvalidPunycode`](#ignoreinvalidpunycode) +* [`transitionalProcessing`](#transitionalprocessing) +* [`useSTD3ASCIIRules`](#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. + +### `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](https://unicode.org/reports/tr46/#Compatibility_Processing) of the deviation characters. + +### `useSTD3ASCIIRules` + +Type: `boolean` +Default value: `false` +When set to `true`, input will be validated according to [STD3 Rules](http://unicode.org/reports/tr46/#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. |
