# @sirusdev/p2pchat-browser-sdk

> library to develop p2p chat client on browser

Latest version **0.0.7** (published 2020-06-23) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @sirusdev/p2pchat-browser-sdk
pnpm add @sirusdev/p2pchat-browser-sdk
yarn add @sirusdev/p2pchat-browser-sdk
bun add @sirusdev/p2pchat-browser-sdk
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2020-06-23 |
| First published | 2020-06-17 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 526.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | muhammad hasan |
| Maintainers | hasan-sirus, madhajjer, rizkirachyan |
| Keywords | p2p, chat |

## Links

- npm: https://www.npmjs.com/package/@sirusdev/p2pchat-browser-sdk
- npm.io page: https://npm.io/package/@sirusdev/p2pchat-browser-sdk

## Dependencies (9)

- [rxjs](https://npm.io/package/rxjs.md) ^6.5.5
- [uuid](https://npm.io/package/uuid.md) ^8.1.0
- [consola](https://npm.io/package/consola.md) ^2.13.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.7.2
- [grpc-web](https://npm.io/package/grpc-web.md) ^1.1.0
- [lovefield](https://npm.io/package/lovefield.md) ^2.1.12
- [localforage](https://npm.io/package/localforage.md) ^1.7.4
- [google-protobuf](https://npm.io/package/google-protobuf.md) ^3.12.2
- [@improbable-eng/grpc-web](https://npm.io/package/@improbable-eng/grpc-web.md) ^0.12.0

## Recent versions

- 0.0.7 (latest) — 2020-06-23
- 0.0.6 — 2020-06-23
- 0.0.5 — 2020-06-17
- 0.0.4 — 2020-06-17
- 0.0.3 — 2020-06-17
- 0.0.2 — 2020-06-17
- 0.0.1 — 2020-06-17

## README

# P2PChat Browser SDK

libarry to develop peer-to-peer chat cliet on browser

## Quick Start

you should have signalling service installed on your system before use this library, signalling service is necessary to create rooms and manage access to those rooms.

1. install this library via `NPM` repositry

    ```bash
    npm install p2pchat-browser-sdk
    ```

1. simple client usage

    ```typescript
    import {} from 'p2pchat-browser-sdk'

    const client = createNewClient({
      signalingUrl: 'https://my-signalling-service.com',
      logLevel: 'info',
    });

    // get token from signaling service. then you can connect as user
    await client.login('token-from-signalling');
    await client.connect();

    // send message to a rooms
    await client.sendMessage('room-id', {
      type: MessageType.MESSAGE,
      content: 'hello!'
    });

    ```

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