mk-socket-client

1.0.11 • Public • Published

Installation

npm install mk-socket-client or yarn add mk-socket-client

Connect to mk-socket-server

import socketClient from 'mk-socket-client';

socketClient.connect(HOST_URL);

Create action observer

let observer = socketClient.subscribe(action, params, headers);

Observer - onUpdate

get realtime update

observer.onUpdate((response) => {
  console.log(response);
});

response object

key explain
error response error
data response data
request request object see below

Observer - unsubscribe

remove subscription

observer.unsubscribe();

Observer - update

update subscription params

 observer.update(params);

Add request interceptor

socketClient.requestInterceptor = (request, type) => {
  request.headers.authorization = 'TOKEN';
  return request;
};

request object

key explain
action action subscribed
params parameters passed to subscription
headers custom headers
subcriptionId subscription id (private)

Readme

Keywords

none

Package Sidebar

Install

npm i mk-socket-client

Weekly Downloads

31

Version

1.0.11

License

MIT

Unpacked Size

203 kB

Total Files

7

Last publish

Collaborators

  • maxken