# xonlinetracker-core

> Core of XOnlineTracker component (one part of XICS).

Latest version **2.1.0** (published 2017-05-19) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install xonlinetracker-core
pnpm add xonlinetracker-core
yarn add xonlinetracker-core
bun add xonlinetracker-core
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2017-05-19 |
| First published | 2017-05-19 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | The XICS Authors. |
| Maintainers | xiaojsoft |

## Links

- npm: https://www.npmjs.com/package/xonlinetracker-core
- Repository: https://github.com/xics/xonlinetracker-core
- Homepage: https://github.com/xics/xonlinetracker-core#readme
- Issues: https://github.com/xics/xonlinetracker-core/issues
- npm.io page: https://npm.io/package/xonlinetracker-core

## Dependencies (1)

- [fastpriorityqueue](https://npm.io/package/fastpriorityqueue.md) ^0.2.4

## Recent versions

- 2.1.0 (latest) — 2017-05-19

## README

XOnlineTracker (Core)
===
This component is the core of **XOnlineTracker** which tracks the IP address and the key hash of clients.

Installation
---
To install this component, type following commands in the terminal:
> npm install xonlinetracker-core `--save`

API
---
| API                     | Description                                  | Parameters                                                                                 |
|-------------------------|----------------------------------------------|--------------------------------------------------------------------------------------------|
| Clear()                 | Clear saved data.                            |                                                                                            |
| Collect(timeout)        | Collect expired data.                        | timeout (Integer): Expiry timeout.                                                         |
| Query(keyHash)          | Query addresses mapped to specific key hash. | keyHash (String): The hash of the client key.                                              |
| Renew(address, keyHash) | Renew an address-key hash pair.              | address (String): The address of the client. keyHash (String): The hash of the client key. |

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