whois

A simple WHOIS client for NodeJS

Showing:

Popularity

Downloads/wk

6.8K

GitHub Stars

183

Maintenance

Last Commit

2mos ago

Contributors

40

Package

Dependencies

3

License

BSD-2-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Node WHOIS

Build Status

Node WHOIS is a WHOIS client for Node.js.

Installation

Global

$ npm install -g whois

Usage

whois [options] address

Options:
  --version      Show version number                                   [boolean]
  -s, --server   whois server                                    [default: null]
  -f, --follow   number of times to follow redirects                [default: 0]
  -p, --proxy    SOCKS proxy                                     [default: null]
  -v, --verbose  show verbose results                 [boolean] [default: false]
  -b, --bind     bind to a local IP address                      [default: null]
  -h, --help     Show help                            [boolean] [default: false]

Local

$ npm install whois

Usage

var whois = require('whois')
whois.lookup('google.com', function(err, data) {
    console.log(data)
})

You may pass an object in between the address and the callback function to tweak the behavior of the lookup function:

{
    "server":  "",   // this can be a string ("host:port") or an object with host and port as its keys; leaving it empty makes lookup rely on servers.json
    "follow":  2,    // number of times to follow redirects
    "timeout": 0,    // socket timeout, excluding this doesn't override any default timeout value
    "verbose": false // setting this to true returns an array of responses from all servers
    "bind": null     // bind the socket to a local IP address
    "proxy": {       // (optional) SOCKS Proxy
        "host": "",
        "port": 0,
        "type": 5    // or 4
    }
}

Contributing

Contributions are welcome.

License

Node WHOIS is available under the BSD (2-Clause) License.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial