JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10965
  • Score
    100M100P100Q143150F
  • License MIT

OBS Websocket API in Javascript

Package Exports

  • obs-websocket-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (obs-websocket-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

obs-websocket-js

OBSWebSocket.JS allows Javascript-based connections to obs-websocket.

Build Status Latest release Latest Tag

Download | Documentation | Examples

In Development

In the middle of a rewrite.
TODOs include...

  • Travis auto deployments of pre-release and release versions, generation of documentation to gh-pages.
  • Clean up method/event binding.
  • Organize API versioning more efficiently to better allow backwards compatibility.
  • Generate documentation based on API versioning.
  • Unit testing / Socket mocking.

If you can help with any of this please do.

Contributing

  • Install node.js.
  • Clone the repo.
  • Go nuts.
  • Generate the concatenated Javascript file and API documentation by running the following...
npm install
npm install --only=dev
npm run build
  • Run grunt watch using the following. Note that this will only update the distribution js file, not the markdown.
npm run watch

Formatting Guidelines

  • 2 spaces rather than tabs.