# ws-identity-client

> A client for connecting to the web-socket identity server

Latest version **1.0.2** (published 2021-10-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install ws-identity-client
pnpm add ws-identity-client
yarn add ws-identity-client
bun add ws-identity-client
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-10-05 |
| First published | 2021-09-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 16.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Betrand Rioux |
| Maintainers | brioux |

## Links

- npm: https://www.npmjs.com/package/ws-identity-client
- Repository: https://github.com/brioux/ws-identity-client
- Homepage: https://github.com/brioux/ws-identity-client#readme
- Issues: https://github.com/brioux/ws-identity-client/issues
- npm.io page: https://npm.io/package/ws-identity-client

## Dependencies (5)

- [tv4](https://npm.io/package/tv4.md) ^1.2.7
- [debug](https://npm.io/package/debug.md) 3.1.0
- [dockerode](https://npm.io/package/dockerode.md) ^3.3.1
- [@types/debug](https://npm.io/package/@types/debug.md) ^4.1.7
- [request-promise-native](https://npm.io/package/request-promise-native.md) 1.0.7

## Recent versions

- 1.0.2 (latest) — 2021-10-05
- 1.0.1 — 2021-09-28
- 1.0.0 — 2021-09-26

## README

# Client for web-socket identity servers

This is a node.js client to connect with the web-socket identity server [ws-identity](https://github.com/brioux/ws-identity).


## Requesting new session Id 
  - Submit pubKeyHex to socket server and receice ws-identity session ticket
```typescript
  const wsSessionBackend = new WsIdentityClient({
    endpoint: [ws-server-address],
    pathPrefix: "/session",
  });
const sessionId = wsSessionBackend.write("new",{pubKeyHex: [pub-key-hex]});
```

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