@gcorevideo/player 2.20.1 → 2.20.4

package/src/plugins/volume-fade/VolumeFade.ts

@@ -3,11 +3,16 @@ import { reportError } from '@gcorevideo/utils';
 
 import { TimerId } from '../../utils/types.js';
 
+/**
+ * Events emitted by the VolumeFade plugin.
+ * @beta
+ */
 export enum VolumeFadeEvents {
   FADE = 'core:volume:fade',
 }
 
 /**
+ * Applies fade effect to the player's volume change.
  * @beta
  */
 export class VolumeFade extends UICorePlugin {

package/src/types.ts

@@ -57,13 +57,23 @@ export type TransportPreference = MediaTransport
 
 /**
  * @beta
- * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html}, {@link https://clappr.github.io/classes/ContainerPlugin.html}
+ * @see {@link https://clappr.github.io/classes/UIContainerPlugin.html},
+ * {@link https://clappr.github.io/classes/ContainerPlugin.html}
  */
 export type PlayerPlugin = {
   new (...args: any[]): unknown
   name: string
 }
 
+export type PlayerPluginConstructor = CorePluginConstructor | ContainerPluginConstructor
+export type CorePluginConstructor = ((core: unknown) => PlayerPlugin) & {
+  type: 'core'
+}
+
+export type ContainerPluginConstructor = ((container: unknown) => PlayerPlugin) & {
+  type: 'container'
+}
+
 /**
  * Configuration options for the player
  *

package/src/utils/types.ts

@@ -1,6 +1,7 @@
 import { $ } from "@clappr/core";
 
 /**
+ * {@link https://zeptojs.com/#$() | Zepto query result}
  * @beta
  */
 export type ZeptoResult = ReturnType<typeof $>;