A simple, intuitive, and powerful JavaScript signaling library
Features
Fixes
Features
Fixes
Updates
iceGatheringComplete
method to support strategies other than the built in timeoutBreaking Changes
SimpleUser: The call signature for the register
method has changed. It is now register(registererRegisterOptions?: RegistererRegisterOptions): Promise<void>;
. Any RegistererOptions
which were being passed as the first parameter to the register
must now be provided to the constructor of SimpleUser
along with any other options.
UserAgentOptions: The options autoStart
and autoStop
have been removed.
See the Migration Guide from 0.20 to 0.21 for details.
Updates
master
to main
as default development branchFeatures
onAck
delegation for Session (#911)Fixes
Features
Breaking Changes
Fixes
contactName
UserAgent parameter, so this fix changes the checks to only check those if the parameter is set. The server mucking with host and port is entirely legal, so in cases where that occurs usage of contactName
is currently broken.Breaking Changes
hackWssInTransport
UserAgent parameter. If you were using this, it is now replaced with contactParams: { transport: "wss" }
Features
contactName
UserAgent parametercontactParams
UserAgent parameter. It defaults to { transport: "ws" }
Fixes
Fixed a hold issue with 0.17.0 (see #835)
The Session Description Handler has been reworked with tests and documentation added. For users without custom session description handlers, no change will be needed, it is not a breaking change. Existing custom Session Description Handlers will continue to work, unless the old default Session Description Handler was extended (as it's no longer in the same location). For those cases, the old one should be fully copied to your source if you'd like it to continue to work as it did. Extending the old default was not easy, but the new one attempts to rectify this, so in many situations there may be some potential for code cleanup.
Additionally, we will no longer be distributing the webpack-bundled source with our npm package. Importing sip.js
has not been using the webpack bundle for several versions, so we anticipate no issue for most users. For those who imported from sip.js/dist/<one of the bundles>
or used sip.js/dist
in some other fashion, the bundles are still attached to the release notes here, and will continue to be.
Also related to distribution, we now ship with no dependencies and are entirely tree shakeable, so we hope this eliminates a subset of potential issues with bundling and transpiling.
Fixes
Features