Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added - typescript typings #34

Merged
merged 2 commits into from
Apr 12, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
type CommonOptions = {
/** WHOIS server to query. Default: WHOIS server from IANA */
host?: string
/** WHOIS server request timeout in ms. Default: `1500` */
timeout?: number
/** Return the raw WHOIS result in response. Added to `__raw` */
raw?: boolean
}

interface Whoiser {
/**
* Get WHOIS data for any internet address
*
* @param {string|number} query
* @param {Object} options
* @returns {Promise<*>} Parsed WHOIS server response
*/
(query: string | number, options?: CommonOptions & Record<string, string>): Promise<any>


/**
* Get WHOIS data for a TLD
*
* @param {string} tld Ex. `.net`
* @param {Object} options
* @returns {Promise<*>} Parsed WHOIS server response
*/
tld(tld: string, options?: Omit<CommonOptions, 'host'>): Promise<any>;

/**
* Query a WHOIS server for data
*
* @param {Object} options
* @returns {Promise<string>} Raw WHOIS server response
*/
query(options: CommonOptions & {
query: string;
/** Low level end of query suffix. Default `\r\n` */
querySuffix?: string;
}): Promise<string>

/**
* Get parsed WHOIS data for a domain
*
* @param domain
* @param options
*/
domain(
domain: string,
options?: CommonOptions & {
/** How many WHOIS server to query. 1 = registry server (faster), 2 = registry + registrar (more domain details). Default: 2 */
follow?: number
}
): Promise<any>

/**
* Get WHOIS data for a IP
*
* @param {string} ip
* @param {Object} options
* @returns {Promise<*>} Parsed WHOIS server response
*/
ip(ip: string, options?: CommonOptions): Promise<any>

/**
* Get WHOIS data for an AS number
*
* @param {string|number} ans
* @param {Object} options
* @returns {Promise<*>} Parsed WHOIS server response
*/
ans(ans: string | number, options?: CommonOptions): Promise<any>;
AndreiIgna marked this conversation as resolved.
Show resolved Hide resolved

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

declare const whoiser: Whoiser;
export = whoiser;
1 change: 0 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
"name": "whoiser",
"version": "1.10.0",
"description": "Whois info for TLDs, domains and IPs",
"types": "./index.d.ts",
"typings": "./index.d.ts",
"keywords": [
"whois",
"domain",
Expand Down