1.0.11 • Published 6 years ago

mk-socket-client v1.0.11

Weekly downloads
1
License
MIT
Repository
-
Last release
6 years ago

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

keyexplain
errorresponse error
dataresponse data
requestrequest 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

keyexplain
actionaction subscribed
paramsparameters passed to subscription
headerscustom headers
subcriptionIdsubscription id (private)
1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago