video.js - npm Package Compare versions

Comparing version 8.16.1 to 8.17.0

dist/types/component.d.ts

 export default Component;
+/**
+ * A callback to be called if and when the component is ready.
+ * `this` will be the Component instance.
+ */
+export type ReadyCallback = () => void;
 /** @import Player from './player' */
 /**
+ * A callback to be called if and when the component is ready.
+ * `this` will be the Component instance.
+ *
+ * @callback ReadyCallback
+ * @returns  {void}
+ */
+/**
  * Base class for all UI Components.
@@ -43,9 +55,2 @@ * Components are UI objects which represent both a javascript object and an element
     /**
-     * A callback that is called when a component is ready. Does not have any
-     * parameters and any callback value will be ignored.
-     *
-     * @callback ReadyCallback
-     * @this Component
-     */
-    /**
      * Creates an instance of this class.
@@ -73,3 +78,3 @@ *
         className?: string;
-    }, ready?: (this: Component) => Component);
+    }, ready?: ReadyCallback);
     player_: any;
@@ -389,7 +394,4 @@ isDisposed_: boolean;
      *        Function that gets called when the `Component` is ready.
-     *
-     * @return {Component}
-     *         Returns itself; method can be chained.
      */
-    ready(fn: (this: Component) => Component, sync?: boolean): Component;
+    ready(fn: ReadyCallback, sync?: boolean): void;
     readyQueue_: any;
@@ -396,0 +398,0 @@ /**

dist/types/player.d.ts

 export default Player;
+export type PlayerReadyCallback = (this: Player) => void;
 /**
@@ -35,6 +36,6 @@ * An instance of the `Player` class is created when any of the Video.js setup methods
      *
-     * @param {Function} [ready]
+     * @param {PlayerReadyCallback} [ready]
      *        Ready callback function.
      */
-    constructor(tag: Element, options?: any, ready?: Function);
+    constructor(tag: Element, options?: any, ready?: PlayerReadyCallback);
     boundDocumentFullscreenChange_: (e: any) => void;
@@ -41,0 +42,0 @@ boundFullWindowOnEscKey_: (e: any) => void;

dist/types/video.d.ts

 export default videojs;
-/**
- * A callback that is called when a component is ready. Does not have any
- * parameters and any callback value will be ignored. See: {@link Component ~ReadyCallback}
- */
-export type ReadyCallback = () => any;
 export type version = string;
 /**
- * A callback that is called when a component is ready. Does not have any
- * parameters and any callback value will be ignored. See: {@link Component~ReadyCallback}
- *
- * @callback ReadyCallback
- */
-/**
  * The `videojs()` function doubles as the main function for users to create a
@@ -75,3 +64,3 @@ * {@link Player} instance as well as the main library namespace.
  *
- * @param  {ReadyCallback} [ready]
+ * @param  {PlayerReadyCallback} [ready]
  *         A function to be called when the {@link Player} and {@link Tech} are
@@ -83,3 +72,3 @@ *         ready.
  */
-declare function videojs(id: string | Element, options?: any, ready?: ReadyCallback): Player;
+declare function videojs(id: string | Element, options?: any, ready?: PlayerReadyCallback): Player;
 declare namespace videojs {
@@ -217,2 +206,3 @@ export { hooks_ };
 }
+import type { PlayerReadyCallback } from './player';
 import Player from './player';
@@ -219,0 +209,0 @@ import { hooks_ } from './utils/hooks';

package.json

 {
   "name": "video.js",
   "description": "An HTML5 video player that supports HLS and DASH with a common API and skin.",
-  "version": "8.16.1",
+  "version": "8.17.0",
   "main": "./dist/video.cjs.js",
@@ -6,0 +6,0 @@ "module": "./dist/video.es.js",

No alert changes

Improved metrics

Total package byte prevSize

17541582

increased by0.22%

Number of package files

431

increased by0.7%

Lines of code

424091

increased by0.25%

No dependency changes