Installation

npm install --save @types/tldjs

Summary

This package contains type definitions for tldjs (https://github.com/oncletom/tld.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tldjs.

index.d.ts

1export declare function tldExists(host: string): boolean;
2
3export declare function getDomain(host: string): string | null;
4
5export declare function getSubdomain(host: string): string | null;
6
7export declare function getPublicSuffix(host: string): string | null;
8
9/**
10 * @deprecated "isValid" is deprecated, please use "isValidHostname" instead.
11 */
12export declare function isValid(host: string): boolean;
13
14export declare function isValidHostname(host: string): boolean;
15
16export declare function extractHostname(host: string): string | null;
17
18export declare function parse(host: string): {
19    hostname: ReturnType<typeof extractHostname>;
20    isValid: ReturnType<typeof isValid>;
21    isIp: boolean;
22    tldExists: ReturnType<typeof tldExists>;
23    publicSuffix: ReturnType<typeof getPublicSuffix>;
24    domain: ReturnType<typeof getDomain>;
25    subdomain: ReturnType<typeof getSubdomain>;
26};
27
28export declare function fromUserSettings(options: {
29    rules?: any;
30    validHosts?: string[] | undefined;
31    extractHostname?: ReturnType<typeof extractHostname> | undefined;
32}): {
33    extractHostname: typeof extractHostname;
34    isValidHostname: typeof isValidHostname;
35    isValid: typeof isValid;
36    parse: typeof parse;
37    tldExists: typeof tldExists;
38    getPublicSuffix: typeof getPublicSuffix;
39    getDomain: typeof getDomain;
40    getSubdomain: typeof getSubdomain;
41    fromUserSettings: typeof fromUserSettings;
42};
43

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by Joshua DeVinney.