# typingdnaclient-rxjs

> RxJS wrapper for the TypingDna API

Latest version **1.2.0** (published 2021-02-17) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2021-02-17 |
| First published | 2021-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Mohammad-Ali A'RÂBI |
| Maintainers | aerabi |
| Keywords | typingDna, typingDna API, typingDna API client |

## Links

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

## Dependencies (2)

- [rxjs](https://npm.io/package/rxjs.md) ^6.6.3
- [typingdnaclient](https://npm.io/package/typingdnaclient.md) ^1.1.1

## Recent versions

- 1.2.0 (latest) — 2021-02-17
- 1.1.1 — 2021-02-16
- 1.1.0-git — 2021-02-16
- 1.0.1 — 2021-02-12
- 1.0.0 — 2021-02-12

## README

# typingdnaclient-rxjs
RxJS wrapper for the TypingDna API

[![npm](https://img.shields.io/npm/v/typingdnaclient-rxjs)](https://www.npmjs.com/package/typingdnaclient)
[![Infrastructure Tests](https://www.bridgecrew.cloud/badges/github/aerabi/typingdnaclient-rxjs/general)](https://www.bridgecrew.cloud/link/badge?vcs=github&fullRepo=aerabi%2Ftypingdnaclient-rxjs&benchmark=INFRASTRUCTURE+SECURITY)

## Installation
```bash
npm install typingdnaclient-rxjs --save
```

## Instantiation and Usage
```typescript
import { TypingDNAReactiveClient } from 'typingdnaclient-rxjs';

const client = new TypingDNAReactiveClient(apiKey, apiSecret);
client.verify(userId, pattern).subscribe(console.log, console.error);
```

The default TypingDNA API Server is `api.typingdna.com`.
You can use the alternative server `tdna-api.azurewebsites.net`.
```typescript
const server = 'tdna-api.azurewebsites.net';
const client = new TypingDNAReactiveClient(apiKey, apiSecret, server);
```

## Available Methods

```typescript
class TypingDNAReactiveClient {
  auto(
    userId: string,
    typingPattern: string,
    options?: { customField: any }
  ): Observable<AutoResponse>;

  save(userId: string, typingPattern: string): Observable<any>;

  verify(
    userId: string,
    typingPattern: string,
    quality: number,
    options: { deviceSimilarityOnly: boolean }
  ): Observable<VerifyResponse>;
}
```

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