# typingdnaclient

> Basic nodeJs implementation for the TypingDNA.com Auth API

Latest version **1.1.2** (published 2021-08-13) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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 | 1.1.2 |
| Published | 2021-08-13 |
| First published | 2017-11-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Stefan Endres |
| Maintainers | stefanendres |
| Keywords | typingDna, typingDna API, typingDna API client |

## Links

- npm: https://www.npmjs.com/package/typingdnaclient
- Repository: https://github.com/TypingDNA/TypingDnaClient-NodeJs
- Homepage: https://github.com/TypingDNA/TypingDnaClient-NodeJs#readme
- Issues: https://github.com/TypingDNA/TypingDnaClient-NodeJs/issues
- npm.io page: https://npm.io/package/typingdnaclient

## Recent versions

- 1.1.2 (latest) — 2021-08-13
- 1.1.1 — 2020-11-05
- 1.0.5 — 2019-11-20
- 1.0.3 — 2019-01-30
- 1.0.1 — 2019-01-30
- 1.0.0 — 2017-11-02

## README

![alt text](https://typingdna.com/assets/images/typingdna-logo-black.png)

Basic node.js wrapper for the [TypingDNA Authentication API](https://www.typingdna.com/authentication-api.html)

[![npm](https://img.shields.io/npm/v/typingdnaclient.svg)](https://www.npmjs.com/package/typingdnaclient)

## Installing

```shell
npm install typingdnaclient --save
```

## Instantiate client

```javascript
var TypingDnaClient = require('typingdnaclient');
var typingDnaClient = new TypingDnaClient('apiKey', 'apiSecret');
```

The default TypingDNA API Server is __api.typingdna.com__.
You can use the alternative server __tdna-api.azurewebsites.net__.

```javascript
var typingDnaClient = new TypingDnaClient('apiKey', 'apiSecret','tdna-api.azurewebsites.net');
```


## Usage example

Get the previously saved typing patterns count for a user:

```javascript
typingDnaClient.check(
    { userId : 'userID',
      type: '2',
      device: 'desktop'
    },
    function(error, result) {
      if (error) { console.error(error) }
      console.log(result);
    });
```

## Available Methods

```javascript
typingDnaClient.check(options, callback);
typingDnaClient.auto(userId, typingPattern, callback);
typingDnaClient.save(userId, typingPattern, callback);
typingDnaClient.delete(options, callback);
typingDnaClient.verify(userId, typingPattern, quality, callback);
typingDnaClient.match(typingPattern1, typingPattern2, quality, callback);
typingDnaClient.getQuote(minLength, maxLength, callback);
typingDnaClient.server(serverName);
typingDnaClient.requestTimeout(timeout);
```

## Documentation

__https://api.typingdna.com__

## License

Apache-2.0

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