github obs-websocket-community-projects/obs-websocket-js v5.0.0-alpha.0

latest releases: v5.0.6, v5.0.5, v5.0.4...
pre-release2 years ago

This is the first alpha version compatible with 5.x versions of obs-websocket. Unless you're already building for the next version of obs-websocket, skip this and seek v4

Breaking changes

  • Obviously, only 5.x of obs-websocket is supported. In case an older version of the server is detected, connection is automatically closed.
  • Distribution files target a more modern environment allowing it to be smaller for modern browsers and runtimes. Should you still want to target older browsers, make sure to configure your bundler to transpile dependencies.
  • async connect(args = {}) has been changed to async connect(address = 'ws://localhost:4444', password?: string, options?: IdentifyMessageFields)
  • send(type, data) has been replaced with call(type, data), aligning with simpleobsws
    • Due to changes between obs-websocket 4.x and 5.x, you'll likely need to check all send calls anyway to match the new requests list
  • sendCallback has been removed, use promise chain if you want to keep callback syntax (.send(...).then((res) => { ... }, (error) => { ... }))

Internal changes:

  • Rewritten in typescript (thanks @duncte123 #256)
  • Added support for msgpack protocol

Don't miss a new obs-websocket-js release

NewReleases is sending notifications on new releases.