https://github.com/bancolombia/async-dataflow-channel-client-js

Transport client for async dataflow implementation for browsers
https://github.com/bancolombia/async-dataflow-channel-client-js

Last synced: 7 days ago
JSON representation

Transport client for async dataflow implementation for browsers

• Host: GitHub
• URL: https://github.com/bancolombia/async-dataflow-channel-client-js
• Owner: bancolombia
• License: mit
• Archived: true
• Created: 2020-09-28T14:05:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-06T14:30:44.000Z (over 2 years ago)
• Last Synced: 2024-08-01T12:33:31.703Z (3 months ago)
• Language: TypeScript
• Size: 154 KB
• Stars: 4
• Watchers: 9
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### The decision was made to have all async data flow components in a [single repository.](https://github.com/bancolombia/async-dataflow)

# Channel client JS

[![NPM](https://nodei.co/npm/chanjs-client.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/chanjs-client/)

Javascript library for async data flow  implementation for browsers.

- [Channel Client JS](#channel-client-js)

- [How to use](#how-to-use)

  - [Install](#install)

  - [Usage](#asyncclient-basic-usage-example)

- [How can I help?](#how-can-i-help)

## How to use

you need to have a running instances of  [async-dataflow-channel-sender](https://github.com/bancolombia/async-dataflow-channel-sender)

### Install

```npm

npm install chanjs-client --save

```

### AsyncClient basic usage example

You can understand better the flow with this sequence diagram.

![imagen](https://user-images.githubusercontent.com/12372370/137554898-0d652b9c-2598-4e1b-b681-554e0a9f00e7.png)

```javascript

import { AsyncClient } from 'chanjs-client';

...

const client = new AsyncClient({

    socket_url: "wss://some.domain:8984/socket",

    channel_ref: "some_channel_ref",

    channel_secret: "secret_from_some_auth_service",

    heartbeat_interval: 200

});

...

```

   |  **Parameters** | Description                                   | Default Value |

   | -------------------------------- | -------------------------------------- | ------------------ |

   | socket_url                          |[async-dataflow-channel-sender](https://github.com/bancolombia/async-dataflow-channel-sender) cluster url         |       |

   | channel_ref                          | channel getted from rest service of [async-dataflow-channel-sender](https://github.com/bancolombia/async-dataflow-channel-sender)   |                    |

   | channel_secret                          | token getted from rest service of [async-dataflow-channel-sender](https://github.com/bancolombia/async-dataflow-channel-sender)|                    |

   | heartbeat_interval                          | time in milliseconds to verify socket connection  **this parameter must be less than the socket_idle_timeout on the channel sender**|       750            |

  | enable_binary_transport                          | boolean parameter to indicate use binary protocol |       false            |

   

```javascript

client.listenEvent("event.some-name", message => someCallback(message.payload));

```

## How can I help?

Review the [issues](https://github.com/bancolombia/async-dataflow-channel-client-js/issues). Read [how Contributing](hhttps://github.com/bancolombia/async-dataflow-channel-client-js/wiki/Contributing).