@ospin/pusher
v1.2.0
Published
OSPIN package for communcation to the pusher channels of the OSPIN cloud
Downloads
2
Keywords
Readme
Documentation can be found here.
Table of Contents
Overview
@ospin/pusher is a JavaScript SDK to communicate to Ospin's pusher channel for real time information on devices and processes. It is build on top of pusher-js. To use it the user has to be registered at OSPIN.
Configuration
// connect to the client
const userId = "a3339d89-345b-4baf-9859-46a4542a505a"
pusher.OspinClient.connect({
env: 'prod',
userId,
/* using the default auth methods provided in the @ospin/nexus package */
authDeviceSubscriptions: nexus.user.pusher.subscriptions.device.authorizeMany,
authDeviceProcessSubscriptions: nexus.user.pusher.subscriptions.device.process.authorizeMany,
})
Use Example
// subscribe
const deviceId = "b3249d89-345b-4baf-9859-46a4542a505a"
const handlers = {
"device-state-update": data => console.log(data)
}
pusher.DevicePusherChannel.subscribe({ deviceId }, handlers)
// unsubscribe
pusher.DevicePusherChannel.unsubscribe({ deviceId })
// disconnect
pusher.OspinClient.disconnect()
Contributing
This repo employs the github action semantic-release, which, on approved PRs to main
, sniffs the PR title/commit message to automatically bump the semantic versioning and publish the package to NPM.
All PRs to the main
branch should indicate the semantic version change via the following options:
Available types:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes (unclear if this bumps version)
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests or correcting existing tests
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- chore: Other changes that don't modify src or test files
- revert: Reverts a previous commit
Add BREAKING CHANGE into the commit message body (!) to indicate a major version release.