https://github.com/ehanlin/socket-subscriber
https://github.com/ehanlin/socket-subscriber
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ehanlin/socket-subscriber
- Owner: eHanlin
- License: mit
- Created: 2016-10-25T10:04:26.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T08:52:36.000Z (over 9 years ago)
- Last Synced: 2024-05-23T09:02:45.828Z (about 2 years ago)
- Language: JavaScript
- Size: 286 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
socket-subscriber
=====================================
## Demo
[demo page](https://ehanlin.github.io/socket-subscriber/demo/index.html)
## Usage
Create a instance.
```js
var client = new SocketSubscriber(url, {debug:true});
```
Register connect and error events.
```js
client.on('connect', ()=> console.log('connection'));
client.on('close', ()=> console.log('close'));
```
Subscribe a room with register listener.
```js
client.room('type', 'id').on((evt)=> console.log(evt));
```
Subscribe a date pusher with register listener.
```js
client.date().on((evt)=> console.log(evt));
```
Send a message to room.
```js
client.sendRoom('type', 'id', data);
```
## Event
* connect
* close
* idle
## API
### SocketSubscriber(url:string, opts:object?)
> opts.debug(boolean)： Trace logs. (default:false)
> opts.retryCount(Number): The value is retring count. The connection is not retring if value is 0. And value < 0 will retry to connect success. (default: 10000)
> opts.retryTime(Number): Retry delay time. (default: -1)
> opts.idleTime(Number): Set idle time. (default: 600000)
> opts.incomingHeartbeat(Number): Set headrtbeat from server. (default: 1000 ms)
* on(evtName:string, listener:function)
* off(evtName:string, listener:function)
* debug(enabled:boolean)
* date() : Channel
* room(type:string, id:string) : Channel
* exitRoom(type:string ,id: string)
* sendRoom(type:string, id:string, label:string?, data:object?, headers: object?)
* getSockJSSessionId():string
### Channel
* on(evtName:string?, listener:function):Channel
* off(evtName:string?, listener:function):Channel
## Run dev
```sh
npm run dev
```
## Build
```sh
npm run build
```