idna-uts46-hx/dist/index.d.ts

Convert Domain Names correctly from IDN to Punycode and vice-versa and offer TR46 processing.

// partially taken from @types/tr46 as we wrap their lib
/**
 * Converts a string of Unicode symbols to a case-folded Punycode string of ASCII symbols
 * while considering transitional specifics for the underlying tld.
 */
export function toAscii(domainName: string, options?: ToASCIIOptions): string;
/**
 * Converts a case-folded Punycode string of ASCII symbols to a string of Unicode symbols
 * while considering transitional specifics for the underlying tld.
 */
export function toUnicode(domainName: string, options?: Options): string;
/**
 * Converts the given domain name(s) to punycode and ascii
 * while considering transitional specifics for the underlying tlds.
 */
export function convert(domainNames: string | string[], options?: ToASCIIOptions): { IDN: string | string[]; PC: string | string[]; };

export interface Options {
    /**
     * When set to `true`, any bi-directional text within the input will be checked for validation.
     * @default false
     */
    checkBidi?: boolean | undefined;
    /**
     * When set to `true`, the positions of any hyphen characters within the input will be checked for validation.
     * @default false
     */
    checkHyphens?: boolean | undefined;
    /**
     * When set to `true`, any word joiner characters within the input will be checked for validation.
     * @default false
     */
    checkJoiners?: boolean | undefined;
    /**
     * When set to `true`, input will be validated according to [STD3 Rules](http://unicode.org/reports/tr46/#STD3_Rules).
     * @default false
     */
    useSTD3ASCIIRules?: boolean | undefined;
    /**
     * When set to `true`, the length of each DNS label within the input will be checked for validation.
     * @default false
     */
    verifyDNSLength?: boolean | undefined;
}

export interface ToASCIIOptions extends Options {
    /**
     * 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.
     * @default 'nontransitional'
     */
    processingOption?: ProcessingOption | undefined;
}

export type ProcessingOption = "nontransitional" | "transitional";