🤖 Merge PR DefinitelyTyped#60099 fix(video.js): add `requestNamedAnim…

…ationFrame` by @peterblazejewicz https://docs.videojs.com/component#requestNamedAnimationFrame (and minor style changes) /cc @try2beth3b3st Thanks! Fixes DefinitelyTyped#60090
bjubes · Apr 27, 2022 · 44fdc86 · 44fdc86
1 parent 8037183
commit 44fdc86
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 7 deletions.
diff --git a/types/video.js/index.d.ts b/types/video.js/index.d.ts
@@ -647,7 +647,7 @@ declare namespace videojs {
      *
      * @see [Spec]{@link https://html.spec.whatwg.org/multipage/media.html#audiotracklist}
      */
-     interface AudioTrackList extends TrackList {
+    interface AudioTrackList extends TrackList {
         [index: number]: VideojsAudioTrack;
 
         /**
@@ -1608,7 +1608,7 @@ declare namespace videojs {
          * @return The descendant `Component` following the given descendant
          *         `names` or undefined.
          */
-        getDescendant(...names: Array<(string|string[])>): Component|undefined;
+        getDescendant(...names: Array<string | string[]>): Component | undefined;
 
         /**
          * Returns the child `Component` with the given `id`.
@@ -1805,6 +1805,20 @@ declare namespace videojs {
          */
         requestAnimationFrame(fn: Component.GenericCallback): number;
 
+        /**
+         * Request an animation frame, but only one named animation
+         * frame will be queued. Another will never be added until
+         * the previous one finishes.
+         *
+         * @param name
+         *        The name to give this requestAnimationFrame
+         *
+         * @param  fn
+         *         A function that will be bound to this component and executed just
+         *         before the browser's next repaint.
+         */
+        requestNamedAnimationFrame(name: string, fn: Component.GenericCallback): string | undefined;
+
         /**
          * Set the value of an attribute on the `Component`'s element
          *
@@ -3937,12 +3951,12 @@ declare namespace videojs {
         /**
          * Determines the height of the floating video window.
          */
-         height: number;
+        height: number;
 
         /**
          * Determines the width of the floating video window.
          */
-         width: number;
+        width: number;
     }
 
     type Player = VideoJsPlayer;

diff --git a/types/video.js/video.js-tests.ts b/types/video.js/video.js-tests.ts
@@ -166,6 +166,9 @@ videojs('example_video_1', playerOptions).ready(function playerReady() {
         pipWindow;
     });
 
+    // $ExpectType string | undefined
+    this.requestNamedAnimationFrame('animationFrameName', () => {});
+
     // $ExpectType Promise<void>
     this.exitPictureInPicture();
 
@@ -232,7 +235,7 @@ function testComponents(player: videojs.Player) {
     myWindow.isDisposed(); // $ExpectType boolean
     myWindow.dispose(); // $ExpectType void
 
-	const MyOtherWindow = videojs.extend(videojs.getComponent("ModalDialog"), {
+    const MyOtherWindow = videojs.extend(videojs.getComponent('ModalDialog'), {
         myFunction() {
             this.player().play();
         },
@@ -243,11 +246,11 @@ function testComponents(player: videojs.Player) {
     });
 
     const myOtherWindow = new MyOtherWindow(player, {});
-    myOtherWindow.controlText("My text");
+    myOtherWindow.controlText('My text');
     myOtherWindow.open();
     myOtherWindow.close();
     myOtherWindow.myFunction(); // $ExpectType void
-    myOtherWindow.myOtherFunction("test"); // $ExpectType string
+    myOtherWindow.myOtherFunction('test'); // $ExpectType string
 }
 
 function testPlugin(player: videojs.Player, options: {}) {