# telize-node

> An asynchronous client library for Telize API.

Latest version **1.0.7** (published 2022-01-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install telize-node
pnpm add telize-node
yarn add telize-node
bun add telize-node
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2022-01-12 |
| First published | 2015-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anatoliy Gatt |
| Maintainers | agatt |
| Keywords | telize, ip, ipv4, ipv6, geo, json, node |

## Links

- npm: https://www.npmjs.com/package/telize-node
- npm.io page: https://npm.io/package/telize-node

## Dependencies (1)

- [deep-freeze-node](https://npm.io/package/deep-freeze-node.md) ^1.1.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.7 (latest) — 2022-01-12
- 1.0.6 — 2015-11-02
- 1.0.5 — 2015-09-23
- 1.0.4 — 2015-08-29
- 1.0.3 — 2015-08-10
- 1.0.2 — 2015-08-06
- 1.0.1 — 2015-08-01
- 1.0.0 — 2015-08-01

## README

# ⚠️ This package has been deprecated.

![telize-node Logo][logo]

An asynchronous client library for Telize [API](http://telize.com/).

[![NPM Package Version][npm-package-version-badge]][npm-package-url]
[![NPM Package Downloads][npm-package-downloads-badge]][npm-package-url]
[![NPM Package License][npm-package-license-badge]][npm-package-license-url]

## Installation

```shell
npm install telize-node
```

## Quick Start

The quickest way to get started is by executing following code:

```javascript
var telize = require('telize-node')();

telize.getIP(function (error, ip) {
  if (!error) {
    console.log(ip);
  } else {
    console.error(error);
  }
});
```

If everything went well, you'll see your current IP address in the console:

```
46.19.37.108
```

## Documentation

### getIP

Requests current IP address.

#### Example

Requests current IP address.

```javascript
telize.getIP(function (error, ip) {
  if (!error) {
    console.log(ip);
  } else {
    console.error(error);
  }
});
```

#### Errors

When errors occur, you receive an error object with default properties as a first argument of the callback.

---

### getGeoIP

Requests Geo IP data.

#### Examples

Requests GeoIP data for current IP address.

```javascript
telize.getGeoIP(function (error, data) {
  if (!error) {
    console.log(data);
  } else {
    console.error(error);
  }
});
```

Requests GeoIP data for manually set IPv4 address.

```javascript
telize.getGeoIP('46.19.37.108', function (error, data) {
  if (!error) {
    console.log(data);
  } else {
    console.error(error);
  }
});
```

Requests GeoIP data for manually set IPv6 address.

```javascript
telize.getGeoIP('2a02:2770::21a:4aff:feb3:2ee', function (error, data) {
  if (!error) {
    console.log(data);
  } else {
    console.error(error);
  }
});
```

#### Errors

When errors occur, you receive an error object with default properties as a first argument of the callback.

## Tests

To run the test suite, first install the dependencies, then run `npm test`:

```bash
$ npm install
$ npm test
```

## License

Distributed under the [MIT License](https://opensource.org/licenses/MIT).

[logo]: https://cldup.com/mRUAz79vf1.png
[npm-package-url]: https://npmjs.org/package/telize-node
[npm-package-version-badge]: https://img.shields.io/npm/v/telize-node.svg?style=flat-square
[npm-package-license-badge]: https://img.shields.io/npm/l/telize-node.svg?style=flat-square
[npm-package-license-url]: http://opensource.org/licenses/MIT
[npm-package-downloads-badge]: https://img.shields.io/npm/dm/telize-node.svg?style=flat-square

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