Skip to content

Releases: obs-websocket-community-projects/obs-websocket-js

v5.0.0-alpha.4

08 Jan 07:42
be4b563
Compare
Choose a tag to compare

v5.0.0-alpha.3

01 Jan 11:17
v5.0.0-alpha.3
a92ceeb
Compare
Choose a tag to compare
v5.0.0-alpha.3 Pre-release
Pre-release

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

  • Add __esModule flag to improve support for cjs scripts using esModuleInterop
  • Flag package as side-effect free

v5.0.0-alpha.2

29 Dec 11:01
v5.0.0-alpha.2
6459d6c
Compare
Choose a tag to compare

v5.0.0-alpha.1

23 Dec 19:51
v5.0.0-alpha.1
6b77838
Compare
Choose a tag to compare
v5.0.0-alpha.1 Pre-release
Pre-release

For changes between 4.x and 5.x see release notes for v5.0.0-alpha.0

  • Improve error object when connection fails in browsers
  • Typescript: export EventTypes (map of all events including internal)
  • Update typings to the latest obs-websocket commit

v5.0.0-alpha.0

17 Dec 21:48
v5.0.0-alpha.0
444772d
Compare
Choose a tag to compare
v5.0.0-alpha.0 Pre-release
Pre-release

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

v4.0.3

15 Aug 18:14
v4.0.3
36633b3
Compare
Choose a tag to compare