Просмотр исходного кода

fix(ts) update jsdoc to appease typescript

tags/v0.0.2
Jorge Oliveira 2 лет назад
Родитель
Сommit
ef1031d88d

+ 2
- 2
JitsiMeetJS.ts Просмотреть файл

@@ -304,7 +304,6 @@ export default {
304 304
         window.connectionTimes['obtainPermissions.start']
305 305
             = window.performance.now();
306 306
 
307
-        // @ts-ignore
308 307
         return RTC.obtainAudioAndVideoPermissions(restOptions)
309 308
             .then(tracks => {
310 309
                 promiseFulfilled = true;
@@ -531,7 +530,8 @@ export default {
531 530
     /**
532 531
      * Informs lib-jitsi-meet about the current network status.
533 532
      *
534
-     * @param {boolean} isOnline - {@code true} if the internet connectivity is online or {@code false}
533
+     * @param {object} state - The network info state.
534
+     * @param {boolean} state.isOnline - {@code true} if the internet connectivity is online or {@code false}
535 535
      * otherwise.
536 536
      */
537 537
     setNetworkInfo({ isOnline }) {

+ 4
- 4
modules/RTC/RTC.js Просмотреть файл

@@ -212,10 +212,10 @@ export default class RTC extends Listenable {
212 212
     /**
213 213
      * Creates the local MediaStreams.
214 214
      * @param {object} [options] Optional parameters.
215
-     * @param {array} options.devices The devices that will be requested.
216
-     * @param {string} options.resolution Resolution constraints.
217
-     * @param {string} options.cameraDeviceId
218
-     * @param {string} options.micDeviceId
215
+     * @param {Array=} options.devices The devices that will be requested.
216
+     * @param {string=} options.resolution Resolution constraints.
217
+     * @param {string=} options.cameraDeviceId
218
+     * @param {string=} options.micDeviceId
219 219
      * @returns {*} Promise object that will receive the new JitsiTracks
220 220
      */
221 221
     static obtainAudioAndVideoPermissions(options) {

+ 4
- 0
modules/connectivity/NetworkInfo.js Просмотреть файл

@@ -26,6 +26,10 @@ export class NetworkInfo extends Listenable {
26 26
 
27 27
     /**
28 28
      * Updates the network info state.
29
+     *
30
+     * @param {object} state - The network info state.
31
+     * @param {boolean} state.isOnline - {@code true} if the internet connectivity is online or {@code false}
32
+     * otherwise.
29 33
      */
30 34
     updateNetworkInfo({ isOnline }) {
31 35
         logger.debug('updateNetworkInfo', { isOnline });

+ 5
- 3
modules/flags/FeatureFlags.js Просмотреть файл

@@ -11,9 +11,11 @@ class FeatureFlags {
11 11
     /**
12 12
      * Configures the module.
13 13
      *
14
-     * @param {boolean} flags.runInLiteMode - Enables lite mode for testing to disable media decoding.
15
-     * @param {boolean} flags.sourceNameSignaling - Enables source names in the signaling.
16
-     * @param {boolean} flags.receiveMultipleVideoStreams - Signal support for receiving multiple video streams.
14
+     * @param {object} flags - The feature flags.
15
+     * @param {boolean=} flags.enableUnifiedOnChrome - Enable unified plan implementation support on Chromium.
16
+     * @param {boolean=} flags.runInLiteMode - Enables lite mode for testing to disable media decoding.
17
+     * @param {boolean=} flags.sourceNameSignaling - Enables source names in the signaling.
18
+     * @param {boolean=} flags.receiveMultipleVideoStreams - Signal support for receiving multiple video streams.
17 19
      */
18 20
     init(flags) {
19 21
         this._receiveMultipleVideoStreams = flags.receiveMultipleVideoStreams ?? true;

+ 1
- 1
modules/util/AuthUtil.js Просмотреть файл

@@ -12,7 +12,7 @@ const AuthUtil = {
12 12
      * @param urlPattern a URL pattern pointing to the login service
13 13
      * @param roomName the name of the conference room for which the user will
14 14
      * be authenticated
15
-     * @param {bool} roleUpgrade <tt>true</tt> if the URL will be used for role
15
+     * @param {boolean} roleUpgrade <tt>true</tt> if the URL will be used for role
16 16
      * upgrade scenario, where the user logs-in from the popup window in order
17 17
      * to have the moderator rights granted
18 18
      *

Загрузка…
Отмена
Сохранить