Skip to content

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

v5.0.5

25 Feb 23:20
v5.0.5
7c9c934
Compare
Choose a tag to compare
  • Updated typings

Full Changelog: v5.0.4...v5.0.5

v5.0.4

08 Jan 14:36
Compare
Choose a tag to compare

What's Changed

  • fix: fix type error with moduleResolution node16 by @Hoishin in #333
  • fix: don't export debug by @mint-dewit in #347
    Minor breaking change: Removes debug export, which you've probably haven't used anyway
  • Updated typings

Full Changelog: v5.0.3...v5.0.4

v5.0.3

20 May 14:34
v5.0.3
d6244bb
Compare
Choose a tag to compare

What's Changed

  • Updated typings from obs-websocket 5.0.2 by @dangmai in #308

Full Changelog: v5.0.2...v5.0.3

v5.0.2

30 Sep 20:58
v5.0.2
4972811
Compare
Choose a tag to compare

Full Changelog: v5.0.1...v5.0.2

v5.0.1

03 Aug 04:55
v5.0.1
86c0060
Compare
Choose a tag to compare
  • Renaming GetGroupItemList to GetGroupSceneItemList by @i-false in #294

(No changes in typings in obs-websocket 5.0.1)

Full Changelog: v5.0.0...v5.0.1

v5.0.0

04 Jul 06:45
v5.0.0
159cd55
Compare
Choose a tag to compare

v5 is made for obs-websocket versions 5.x that uses a completely new protocol and isn't backwards compatible with 4.x. If you're planning to build something for 4.x, consider upgrading (as all releases for future obs versions will be based on v5) or use the latest/last v4 version.

Breaking changes

  • Obviously, only 5.x of obs-websocket is supported. In case an older version of the server is detected, the connection is automatically closed and the connect promise is rejected
  • Distribution files target a more modern environment allowing for smaller builds 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 request names
  • sendCallback has been removed, use the promise chain if you want to keep callback syntax (.send(...).then((res) => { ... }, (error) => { ... }))

v5.0.0-beta.2

24 Jun 14:40
v5.0.0-beta.2
3340572
Compare
Choose a tag to compare
v5.0.0-beta.2 Pre-release
Pre-release

v5.0.0-beta.1

05 Mar 12:15
v5.0.0-beta.1
4e4a75e
Compare
Choose a tag to compare

v5.0.0-alpha.5

09 Jan 10:17
v5.0.0-alpha.5
ecc17c2
Compare
Choose a tag to compare
v5.0.0-alpha.5 Pre-release
Pre-release

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

  • Fixed __esModule flag for improved support for cjs scripts using esModuleInterop

v5.0.0-alpha.4

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