Remove deprecated jsdoc field as it was misleading (#399)

millicast · Jul 12, 2024 · 5784247 · 5784247
1 parent 2feefa2
commit 5784247
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/packages/millicast-sdk/src/types/index.d.ts b/packages/millicast-sdk/src/types/index.d.ts
@@ -1295,7 +1295,7 @@ declare module '@millicast/sdk' {
    *
    * - A connection path that you can get from {@link Director} module or from your own implementation.
    * @constructor
-   * @deprecated {String} streamName - Millicast stream name. Note that this field is now deprecated and no longer used internally. It will be removed in a future version.
+   * @param {String} streamName - Deprecated: Millicast stream name to connect to. Use tokenGenerator instead. This field will be removed in a future version.
    * @param {TokenGeneratorCallback} tokenGenerator - Callback function executed when a new token is needed.
    * @param {Boolean} [autoReconnect=true] - Enable auto reconnect to stream.
    */
@@ -1362,7 +1362,7 @@ declare module '@millicast/sdk' {
    *
    * - A connection path that you can get from {@link Director} module or from your own implementation.
    * @constructor
-   * @deprecated {String} streamName - Millicast stream name to connect to. Note that this field is now deprecated and no longer used internally. It will be removed in a future version
+   * @param {String} streamName - Deprecated: Millicast stream name to connect to. Use tokenGenerator instead. This field will be removed in a future version.
    * @param {TokenGeneratorCallback} tokenGenerator - Callback function executed when a new token is needed.
    * @param {HTMLMediaElement} [mediaElement=null] - Target HTML media element to mount stream.
    * @param {Boolean} [autoReconnect=true] - Enable auto reconnect to stream.

diff --git a/packages/millicast-sdk/src/utils/BaseWebRTC.js b/packages/millicast-sdk/src/utils/BaseWebRTC.js
@@ -28,8 +28,7 @@ const baseInterval = 1000
  * @classdesc Base class for common actions about peer connection and reconnect mechanism for Publishers and Viewer instances.
  *
  * @constructor
- * @deprecated streamName is no longer used, use tokenGenerator
- * @param {String} streamName - Deprecated: Millicast existing stream name.
+ * @param {String} streamName - Deprecated: Millicast existing stream name. Use tokenGenerator instead.
  * @param {tokenGeneratorCallback} tokenGenerator - Callback function executed when a new token is needed.
  * @param {Object} loggerInstance - Logger instance from the extended classes.
  * @param {Boolean} autoReconnect - Enable auto reconnect.