DefinitelyTyped/types/tldjs/index.d.ts

// Type definitions for tldjs v1.7
// Project: https://github.com/oncletom/tld.js
// Definitions by: Joshua DeVinney <https://github.com/geoffreak>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * tld.js methods getDomain and getSubdomain are designed to work only with valid TLDs.
 * This way, you can trust what a domain is. Unfortunately, localhost is a valid hostname but it is not a TLD.
 * Optionally use validHosts to add it. `tld.validHosts = ['localhost'];`
 */
export declare var validHosts: string[];

/**
 * Checks if the TLD is valid for a given host.
 * @param host The TLD/host/url to check
 * @return {boolean}
 */
export declare function tldExists(host: string): boolean;

/**
 * Returns the fully qualified domain from a host string.
 * @param host The host/url to check
 * @return {string|null} a domain string if any, otherwise null
 */
export declare function getDomain(host: string): string | null;

/**
 * Returns the complete subdomain for a given host.
 * @param host The host/url to check
 * @return {string|null} a subdomain string if any, blank string if subdomain is empty, otherwise null
 */
export declare function getSubdomain(host: string): string | null;

/**
 * Returns the public suffix (including exact matches)
 * @param host The host/url to check
 * @return {string|null} a public suffix string if any, otherwise null
 */
export declare function getPublicSuffix(host: string): string | null;

/**
 * Checking if a host string is valid
 * It's usually a preliminary check before trying to use getDomain or anything else
 * Beware: it does not check if the TLD exists.
 * @param host The host/url to check
 * @return {boolean}
 */
export declare function isValid(host: string): string | null;