Releases: obs-websocket-community-projects/obs-websocket-js
Releases · obs-websocket-community-projects/obs-websocket-js
v5.0.6
What's Changed
- add: OBS Websocket v5.5 features by @digitaldrummerj in #357
- fix CommonJS imports with Node16 ModuleResolutions #355
Full Changelog: v5.0.5...v5.0.6
v5.0.5
- Updated typings
Full Changelog: v5.0.4...v5.0.5
v5.0.4
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: Removesdebug
export, which you've probably haven't used anyway - Updated typings
Full Changelog: v5.0.3...v5.0.4
v5.0.3
v5.0.2
- Implement Request Batches with
callBatch
by @faultyserver in #306
Full Changelog: v5.0.1...v5.0.2
v5.0.1
(No changes in typings in obs-websocket 5.0.1)
Full Changelog: v5.0.0...v5.0.1
v5.0.0
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 toasync connect(address = 'ws://localhost:4444', password?: string, options?: IdentifyMessageFields)
send(type, data)
has been replaced withcall(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
- Due to changes between obs-websocket 4.x and 5.x, you'll likely need to check all
sendCallback
has been removed, use the promise chain if you want to keep callback syntax (.send(...).then((res) => { ... }, (error) => { ... })
)
v5.0.0-beta.2
- Updated builds used by CDN's to use .js extension:
https://cdn.jsdelivr.net/npm/[email protected]/dist/obs-ws.min.js
https://unpkg.com/[email protected]/dist/obs-ws.min.js - Improved typescript compatibility for explicit transport format (
import ... from 'obs-websocket-js/json'
)
v5.0.0-beta.1
v5.0.0-alpha.5
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