# werist

> a whois client for node.js

Latest version **0.3.3** (published 2019-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install werist
pnpm add werist
yarn add werist
bun add werist
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2019-04-15 |
| First published | 2017-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 6 |
| Unpacked size | 115.7 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Andreas Diem |
| Maintainers | w4andy |
| Keywords | whois, whois-client, whoisclient |

## Links

- npm: https://www.npmjs.com/package/werist
- Repository: https://github.com/w4andy/node-werist
- Homepage: https://github.com/w4andy/node-werist#readme
- Issues: https://github.com/w4andy/node-werist/issues
- npm.io page: https://npm.io/package/werist

## Dependencies (6)

- [iconv](https://npm.io/package/iconv.md) 2.3.4
- [socks](https://npm.io/package/socks.md) 2.3.2
- [tldjs](https://npm.io/package/tldjs.md) 2.3.1
- [punycode](https://npm.io/package/punycode.md) 2.1.1
- [ip-address](https://npm.io/package/ip-address.md) 5.9.0
- [detect-character-encoding](https://npm.io/package/detect-character-encoding.md) 0.7.0

## Recent versions

- 0.3.3 (latest) — 2019-04-15
- 0.3.2 — 2018-07-04
- 0.3.1 — 2017-11-13
- 0.3.0 — 2017-10-08
- 0.2.4 — 2017-09-27
- 0.2.3 — 2017-09-24
- 0.2.2 — 2017-09-21
- 0.2.1 — 2017-09-19

## README

# node-werist

**_A whois client for node.js_**



_Wer ist are the German words for who is_

[![Build Status](https://travis-ci.org/w4andy/node-werist.svg?branch=master)](https://travis-ci.org/w4andy/node-werist)

## Table of Contents

 - [ChangeLog](https://github.com/w4andy/node-werist/blob/master/CHANGELOG.markdown)
 - [License](https://github.com/w4andy/node-werist/blob/master/LICENSE)
 - [Usage](#usage)
 - [Credit](#credit)

## Installation

```
$ npm install werist
```

## Usage

### With Class

```js
const Werist = require('werist').Werist;
const werist = new Werist(); 
werist.lookup('google.com', function(err, data) {
  console.log(data)
})
```


### Without Class

```js
const werist = require('werist')
werist.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:

```js
{
  "server": null,   // this can be a string ("host:port"); leaving it empty then werist chooses the server 
  "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": {        // Socks Proxy
    "ipaddress": null,
    "port": 0,
    "type": 5       // or 4
  }
}
```

## Credit


node-werist is inspired by [rfc1036/whois](https://github.com/rfc1036/whois) and [FurqanSoftware/node-whois](https://github.com/FurqanSoftware/node-whois)

---
_Source: https://npm.io/package/werist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._