index.d.ts

declare module 'whoiser' {
	export interface Options {
		/**
		 * WHOIS server to query.
		 */
		host?: string

		port?: number

		/**
		 * WHOIS server request timeout in ms.
		 *
		 * @default: 1500
		 */
		timeout?: number

		/**
		 * How many WHOIS server to query.
		 * 1 = registry server (faster),
		 * 2 = registry + registrar (more domain details).
		 *
		 * @default: 2
		 */
		follow?: number

		/**
		 * Return the raw WHOIS result in response.
		 * Added to `__raw`
		 */
		raw?: boolean

		query?: string

		/**
		 * Low level end of query suffix.
		 *
		 * @default '\r\n'
		 */
		querySuffix?: string

		/**
		 * Ignore the protected WHOIS data from response
		 * and eplace them with empty values
		 * @default true
		 */
		ignorePrivacy?: boolean
	}

	export type OptionsIp = Pick<Options, 'host' | 'timeout' | 'raw'>
	export type OptionsAsn = OptionsIp
	export type OptionsQuery = Omit<Options, 'raw' | 'follow'>
	export type OptionsTld = Pick<Options, 'timeout' | 'raw'>
	export type OptionsDomain = Omit<Options, 'querySuffix' | 'query' | 'port'>
	export type OptionsGeneric = OptionsIp | OptionsTld | OptionsDomain

	export interface WhoisSearchResult {
		[key: string]: string | Array<string> | WhoisSearchResult
	}

	/**
	 * Returns a list of all TLDs,
	 * [downloaded from IANA](https://www.iana.org/domains/root/db)
	 *
	 * @returns {Promise<string[]>}
	 */
	export function allTlds(): Promise<string[]>

	/**
	 * Get WHOIS data for an AS number
	 *
	 * @param {string|number} asn
	 * @param {OptionsAsn} options
	 * @returns {Promise<WhoisSearchResult>} Parsed WHOIS server response
	 */
	export function asn(asn: string | number, options?: OptionsAsn): Promise<WhoisSearchResult>

	/**
	 * Get parsed WHOIS data for a domain
	 *
	 * @param {string} domain
	 * @param {OptionsDomain} options
	 * @returns {Promise<WhoisSearchResult>} Parsed WHOIS server response
	 */
	export function domain(domain: string, options?: OptionsDomain): Promise<WhoisSearchResult>

	/**
	 * Get WHOIS data for a IP
	 *
	 * @param {string} ip
	 * @param {OptionsIp} options
	 * @returns {Promise<WhoisSearchResult>} Parsed WHOIS server response
	 */
	export function ip(ip: string, options?: OptionsIp): Promise<WhoisSearchResult>

	/**
	 * Query a WHOIS server for data
	 *
	 * @param {OptionsQuery} options
	 * @returns {Promise<string>} Raw WHOIS server response
	 */
	export function query(options: OptionsQuery): Promise<string>

	/**
	 * Get WHOIS data for a TLD
	 *
	 * @param {string} tld Ex. `.net`
	 * @param {OptionsTld} options
	 * @returns {Promise<WhoisSearchResult>} Parsed WHOIS server response
	 */
	export function tld(tld: string, options?: OptionsTld): Promise<WhoisSearchResult>

	/**
	 * Tries to guess query type and get WHOIS data
	 *
	 * @param {string} query
	 * @param {Options} options
	 * @returns {Promise<WhoisSearchResult>} Parsed WHOIS server response
	 */
	export function whoiser(query: string, options?: OptionsGeneric): Promise<WhoisSearchResult>

	export default whoiser
}