https://github.com/microfocus/octane-websockets-client-nodejs
WebSockets client providing connectivity to ALM Octane's endpoints (NodeJS env)
https://github.com/microfocus/octane-websockets-client-nodejs
octane
Last synced: 5 months ago
JSON representation
WebSockets client providing connectivity to ALM Octane's endpoints (NodeJS env)
- Host: GitHub
- URL: https://github.com/microfocus/octane-websockets-client-nodejs
- Owner: MicroFocus
- License: apache-2.0
- Created: 2019-06-23T14:30:41.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-29T07:55:04.000Z (almost 5 years ago)
- Last Synced: 2024-12-28T16:49:02.113Z (over 1 year ago)
- Topics: octane
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## Summary
`octane-websockets-client-nodejs` is intended to simplify connection to ALM Octane's WebSocket endpoints.
#### Usage
First, __bundle__ the library's relevant version to your package with package manager's standard ways.
(TODO: we should publish the library to NPM or something like this)
Next, __import__ the library into your code from wherever it is placed:
```javascript 1.8
const octaneWSClient = require('octane-ws-client');
```
This imported client can connect to multiple endpoints.
Use `connect` method to provide the configuration of the targeted WS endpoint.
This method may be called any number of times and will connect that number of WS clients, so call it wisely.
While performing connection, the library will:
- verify the configuration
- perform the login
- perform the connection
- bind your custom provided (if provided) `onMessage` method to the WS so that on any incoming message it'll be called
#### API
`connect`
- async
- receives __configuration object__
- returns __Octane WebSocket client__
`configuration object` shaped as following:
```
{
"isSSL": false,
"octaneHost": "localhost",
"octanePort": 8080,
"sharedSpace": 1001,
"endpoint": "webhooks",
"onMessage": ,
"client": "ws_yje4rozx2o21xtpxp3eeon2d0",
"secret": "(ac51444da788a8b7K",
"proxyHost": "",
"proxyPort": ""
}
```
`Octane WebSocket client` shaped as following:
```
{
"onError": ,
"onMessage":
}
```
> `onMessage` function MAY be passed as part of an initial configuration, and/or set later on, on the client object self.