fix(xgplayer):类型声明修正

packages/xgplayer/src/mediaProxy.js

@@ -106,22 +106,27 @@ class MediaProxy extends EventEmitter {
   constructor (options) {
     super(options)
     /**
+     * @type { boolean }
      * @private
      */
     this._hasStart = false
     /**
+     * @type { number }
      * @private
      */
     this._currentTime = 0
     /**
+     * @type { number }
      * @private
      */
     this._duration = 0
     /**
+     * @type {{[propName: string]: any}}
      * @private
      */
     this._internalOp = {}
     /**
+     * @type { boolean }
      * @private
      */
     this._lastMuted = false

packages/xgplayer/src/player.js

@@ -545,7 +545,7 @@ class Player extends MediaProxy {
 
   /**
    *
-   * @param { any } url
+   * @param { any } [url]
    * @returns
    */
   _startInit (url) {
@@ -2456,7 +2456,7 @@ class Player extends MediaProxy {
 
   /**
    * 累计观看时长
-   * @type number
+   * @type { number }
    */
   get cumulateTime () {
     const { acc, t } = this._accPlayed

packages/xgplayer/src/plugin/plugin.js

@@ -144,7 +144,7 @@ function registerTextObj (textConfig, plugin) {
 class Plugin extends BasePlugin {
   /**
     * 插入dom结构
-    * @param { String | HTMLElement } html html字符串或者dom
+    * @param { string | HTMLElement } html html字符串或者dom
     * @param { HTMLElement } parent
     * @param { number } index
     * @returns { HTMLElement }
@@ -193,8 +193,8 @@ class Plugin extends BasePlugin {
   /**
    *
    * @param { HTMLElement } root
-   * @param { String } querySelector
-   * @param { String | Array<String> } eventType
+   * @param { string } querySelector
+   * @param { string | Array<string> } eventType
    * @param { Function } callback
    * @param { boolean } [capture=false]
    * @returns
@@ -573,7 +573,6 @@ class Plugin extends BasePlugin {
   }
 
   /**
-   *
    * @param { string } [value]
    * @returns
    */
@@ -585,7 +584,7 @@ class Plugin extends BasePlugin {
     const cs = window.getComputedStyle(this.root, null)
     const cssDisplayValue = cs.getPropertyValue('display')
     if (cssDisplayValue === 'none') {
-      return (this.root.style.display = 'block')
+      this.root.style.display = 'block'
     }
   }
 

packages/xgplayer/src/plugins/common/optionList.js

@@ -76,6 +76,7 @@ export default class OptionList {
     return obj
   }
 
+
   show () {
     Util.removeClass(this.root, 'hide')
     Util.addClass(this.root, 'active')

packages/xgplayer/src/plugins/common/optionsIcon.js

@@ -131,7 +131,11 @@ export default class OptionsIcon extends Plugin {
     Util.addClass(this.find('.xgplayer-icon'), 'btn-text')
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (!this.config.list || this.config.list.length < 2) {
       return
     }

packages/xgplayer/src/plugins/controls/index.js

@@ -115,7 +115,11 @@ class Controls extends Plugin {
     Util.removeClass(this.root, STATE_CLASS.CONTROLS_AUTOHIDE)
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     this.root.style.display = ''
     this.player.focus()
   }

packages/xgplayer/src/plugins/danmu/index.js

@@ -37,6 +37,7 @@ class Danmu extends Plugin {
     this.seekCost = 0
     /**
      * @readonly
+     * @type {number}
      */
     this.intervalId = 0
     /**

packages/xgplayer/src/plugins/definition/index.js

@@ -75,7 +75,11 @@ export default class DefinitionIcon extends OptionsIcon {
     }
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (!this.config.list || this.config.list.length < 2){
       return
     }

packages/xgplayer/src/plugins/dynamicBg/index.js

@@ -19,7 +19,7 @@ function nowTime () {
 
 /**
  * Check whether the current environment supports canvas
- * @returns { Boolean }
+ * @returns { boolean }
  */
 function checkIsSupportCanvas () {
   try {

packages/xgplayer/src/plugins/fpsDetect/index.js

@@ -24,6 +24,9 @@ export default class FpsDetect extends BasePlugin {
 
   afterCreate () {
     const { player, config } = this
+    /**
+     * @type {null | number}
+     */
     this.timer = null
     this._lastDecodedFrames = 0
     this._currentStuckCount = 0

packages/xgplayer/src/plugins/fullscreen/index.js

@@ -40,9 +40,6 @@ export default class Fullscreen extends IconPlugin {
     }
   }
 
-  /**
-   * @private
-   */
   afterCreate () {
     super.afterCreate()
     const { config, playerConfig } = this
@@ -110,9 +107,6 @@ export default class Fullscreen extends IconPlugin {
     }
   }
 
-  /**
-   * @private
-   */
   registerIcons () {
     return {
       fullscreen: { icon: FullScreenSvg, class: 'xg-get-fullscreen' },
@@ -187,16 +181,7 @@ export default class Fullscreen extends IconPlugin {
     }
   }
 
-  show () {
-    super.show()
-  }
-
-  hide () {
-    super.hide()
-  }
-
   /**
-   * @private
    * @returns
    */
   render () {

packages/xgplayer/src/plugins/mobile/index.js

@@ -113,10 +113,6 @@ class MobilePlugin extends Plugin {
     return this.playerConfig.timeOffset || 0
   }
 
-  /**
-   * @private
-   * @returns {[propName: string]: any}
-   */
   registerIcons () {
     return {
       seekTipIcon: { icon: SeekTipIcon, class: 'xg-seek-pre' }

packages/xgplayer/src/plugins/mobile/touch.js

@@ -56,7 +56,13 @@ class Touche {
     })
     this.root = dom
     this.events = config.eventType === 'mouse' ? MOUSES : TOUCHS
+    /**
+     * @type { null | number}
+     */
     this.pressIntrvalId = null
+    /**
+     * @type { null | number}
+     */
     this.dbIntrvalId = null
     this.__handlers = {}
     this._initEvent()

packages/xgplayer/src/plugins/netAdaption/index.js

@@ -7,6 +7,9 @@ export default class NetAdaption extends BasePlugin {
   }
 
   afterCreate () {
+    /**
+     * @type {null | number}
+     */
     this._timer = setInterval(this._checkStatus.bind(this), 300)
   }
 

packages/xgplayer/src/plugins/playbackRate/index.js

@@ -67,7 +67,11 @@ export default class PlaybackRate extends OptionsIcon {
     this.renderItemList()
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (!this.config.list || this.config.list.length === 0) {
       return
     }

packages/xgplayer/src/plugins/poster/index.js

@@ -38,7 +38,11 @@ class Poster extends Plugin {
     Util.addClass(this.root, 'hide')
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     Util.removeClass(this.root, 'hide')
   }
 

packages/xgplayer/src/plugins/progress/index.js

@@ -113,7 +113,11 @@ class Progress extends Plugin {
     this.useable = useable
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     this.root && (this.root.style.display = 'flex')
   }
   /**
@@ -566,10 +570,10 @@ class Progress extends Plugin {
 
   /**
    * @description 根据currenTime和占用百分比更新进度条
-   * @param {Number} currentTime 需要更新到的时间
-   * @param {Number} seekTime 实际seek的时间
-   * @param {Number} percent 更新时间占比
-   * @param {Int} type 触发类型 0-down 1-move 2-up
+   * @param {number} currentTime 需要更新到的时间
+   * @param {number} seekTime 实际seek的时间
+   * @param {number} percent 更新时间占比
+   * @param {int} type 触发类型 0-down 1-move 2-up
    */
   updateWidth (currentTime, seekTime, percent, type) {
     const { config, player } = this

packages/xgplayer/src/plugins/progressPreview/index.js

@@ -442,7 +442,11 @@ export default class ProgressPreview extends Plugin {
     Util.addClass(this.root, 'hide')
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     Util.removeClass(this.root, 'hide')
   }
 

packages/xgplayer/src/plugins/prompt/index.js

@@ -25,6 +25,9 @@ class Prompt extends Plugin {
   }
 
   afterCreate () {
+    /**
+     * @type {number}
+     */
     this.intervalId = 0
     this.customConfig = null
     this.bind('.highlight', ['click', 'touchend'], (e) => {
@@ -36,7 +39,7 @@ class Prompt extends Plugin {
     })
 
     this.player.showPrompt = (...args) => {
-      this.show(...args)
+      this.showPrompt(...args)
     }
 
     this.player.hidePrompt = () => {
@@ -50,7 +53,7 @@ class Prompt extends Plugin {
     })
   }
 
-  show (detail, config = {}, onClick = () => {}) {
+  showPrompt (detail, config = {}, onClick = () => {}) {
     if (!detail) {
       return
     }

packages/xgplayer/src/plugins/replay/index.js

@@ -65,7 +65,11 @@ class Replay extends Plugin {
     Util.removeClass(this.player.root, 'replay')
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (this.config.disable) {
       return
     }

packages/xgplayer/src/plugins/start/index.js

@@ -148,7 +148,11 @@ class Start extends Plugin {
     Util.addClass(this.root, 'hide')
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     Util.removeClass(this.root, 'hide')
   }
 

packages/xgplayer/src/plugins/testspeed/index.js

@@ -35,6 +35,9 @@ export default class TestSpeed extends BasePlugin {
     }
     this.initSpeedList()
     this.on('real_time_speed', this._onRealSpeedChange)
+    /**
+     * @type {null || number }
+     */
     this.timer = null
     this.cnt = 0
     this.xhr = null

packages/xgplayer/src/plugins/time/index.js

@@ -62,7 +62,11 @@ class Time extends Plugin {
     })
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (this.mode === 'flex') {
       this.centerCurDom && (this.centerCurDom.style.display = 'block')
       this.centerDurDom && (this.centerDurDom.style.display = 'block')

packages/xgplayer/src/plugins/track/index.js

@@ -263,7 +263,11 @@ export default class TextTrack extends OptionsIcon {
     }
   }
 
-  show () {
+  /**
+   * @param {string} [value]
+   * @returns
+   */
+  show (value) {
     if (!this.config.list || this.config.list.length < 1){
       return
     }

packages/xgplayer/src/plugins/waitingTimeoutJump/index.js

@@ -21,6 +21,9 @@ export default class WaitingTimeoutJump extends BasePlugin {
     }
     this.hasPlayed = false
     this.jumpCnt = 0
+    /**
+     * @type {null | number}
+     */
     this.timer = null
     this.jumpSize = jumpSize
     this.on(Events.WAITING, this.onWaiting)