Merge pull request #27 from whawker/optional-options-for-types

Fix types for WebrtcProvider opts as each is optional
yjs · Nov 10, 2021 · 61df807 · 61df807
2 parents e1ee781 + 2f1b3f4
commit 61df807
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/y-webrtc.js b/src/y-webrtc.js
@@ -531,12 +531,12 @@ export class WebrtcProvider extends Observable {
    * @param {string} roomName
    * @param {Y.Doc} doc
    * @param {Object} [opts]
-   * @param {Array<string>} [opts.signaling]
+   * @param {Array<string>?} [opts.signaling]
    * @param {string?} [opts.password]
-   * @param {awarenessProtocol.Awareness} [opts.awareness]
-   * @param {number} [opts.maxConns]
-   * @param {boolean} [opts.filterBcConns]
-   * @param {any} [opts.peerOpts]
+   * @param {awarenessProtocol.Awareness?} [opts.awareness]
+   * @param {number?} [opts.maxConns]
+   * @param {boolean?} [opts.filterBcConns]
+   * @param {any?} [opts.peerOpts]
    */
   constructor (
     roomName,