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) => { ... }))
This version was pushed to npm by t2t2, a new releaser for obs-websocket-js since your current version.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Bumps obs-websocket-js from 4.0.1 to 5.0.2.
Release notes
Sourced from obs-websocket-js's releases.
... (truncated)
Commits
4972811
5.0.2d25337b
Implement Request Batches withcallBatch
(#306)f0d9e29
Update ports in readme (#302)86c0060
5.0.1a1f4614
Add non-minified stanalone buildbc6ac8d
Include GetGroupSceneItemList fix in types generator (fdca73c)fdca73c
Renaming GetGroupItemList to GetGroupSceneItemList (#294)159cd55
5.0.0593a26e
Update readme for v5 release1a20a48
Update typings for obs-websocket 5.0Maintainer changes
This version was pushed to npm by t2t2, a new releaser for obs-websocket-js since your current version.
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)