@parlour/parlour-client/README.md

The parlour websocket client

# parlour-client

> The parlour client

[![NPM](https://img.shields.io/npm/v/reacted.svg)](https://www.npmjs.com/package/reacted) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Support the project

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/samick17)
[![Donate](https://img.shields.io/badge/Donate-BuyMeCoffee-Blue.svg)](https://www.buymeacoffee.com/samick)

## Install

```bash
npm install --save parlour-client
```

## Usage

```js
	
	import { SocketClient } from 'parlour-client';
	const client = SocketClient.create({
		url: 'ws://localhost:8000/socket/websocket',
		userId: 'samick17',
		userName: 'samick',
		token: '',// optional for signin as user
		rooms: ['room:lobby'],
		reconnectPeriod: 0,
	});
	const unbindClientEvents = client.on({
		connect: () => {
			console.log('[Client] Connect');
		},
		'reply': (topic, event, payload) => {
			console.log('[Client] Reply', topic, event, payload);
		},
		'presence_diff': (topic, event, payload) => {
			console.log('[Client] PresenceDiff', topic, event, payload);
		},
		'presence_state': (topic, event, payload) => {
			console.log('[Client] PresenceState', topic, event, payload);
		},
		message: (topic, event, payload) => {
			console.log('[Client] Message', topic, event, payload);
		},
		error: (event) => {
			console.log('[Client] Error', event);
		},
		close: (event) => {
			console.log('[Client] Close', event);
			console.log('Reason: ', event.reason);
		},
		ping: (ping) => {
			console.log('[Client] Ping');
			console.log('Ping: ', ping);
		},
	});
	client.connect();

```

## License

MIT © [samick17](https://github.com/samick17)