@types/wavesurfer.js - npm Package Compare versions

Comparing version 3.2.0 to 3.3.0

wavesurfer.js/index.d.ts

@@ -1,4 +0,6 @@
-// Type definitions for wavesurfer.js 3.2
+// Type definitions for wavesurfer.js 3.3
 // Project: https://github.com/katspaugh/wavesurfer.js
-// Definitions by: Yusuke Higuchi <https://github.com/higuri>, Egor Gorbachev <https://github.com/kubk>
+// Definitions by: Yusuke Higuchi <https://github.com/higuri>
+//                 Egor Gorbachev <https://github.com/kubk>
+//                 Ben Nordstrom <https://github.com/bennordgengo>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -22,2 +24,3 @@ // TypeScript Version: 2.2
     constructor(params: WaveSurfer.WaveSurferParams);
+    static VERSION: string;
     static util: WaveSurfer.WaveSurferUtil;
@@ -29,18 +32,33 @@ static create(params: WaveSurfer.WaveSurferParams): WaveSurfer;
     [x: string]: any;
+    backend: WaveSurfer.WaveSurferBackend;
     util: WaveSurfer.WaveSurferUtil;
+    addPlugin(plugin: WaveSurfer.PluginDefinition): WaveSurfer;
+    cancelAjax(): void;
     destroy(): void;
+    destroyPlugin(name: string): WaveSurfer;
     empty(): void;
+    exportPCM(length?: number, accuracy?: number, noWindow?: boolean, start?: number, end?: number): Promise<string>;
+    exportImage(format?: string, quality?: number, type?: 'dataURL' | 'blob'): string | string[] | Promise<Blob[]>;
+    getActivePlugins(): object;
+    getBackgroundColor(): string;
     getCurrentTime(): number;
+    getCursorColor(): string;
     getDuration(): number;
+    getFilters(): AudioNode[];
+    getHeight(): number;
     getPlaybackRate(): number;
+    getProgressColor(): string;
+    getMute(): boolean;
     getVolume(): number;
-    getMute(): boolean;
-    getFilters(): AudioNode[];
     getWaveColor(): string;
-    exportPCM(length: number, accuracy: number, noWindow?: boolean, start?: number): string;
-    exportImage(format: string, quality: number): string;
-    init(): void;
+    init(): WaveSurfer;
+    initPlugin(name: string): WaveSurfer;
     isPlaying(): boolean;
     isReady(): boolean;
-    load(url: string | HTMLMediaElement, peaks?: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>, preload?: string, duration?: number): void;
+    load(
+        url: string | HTMLMediaElement,
+        peaks?: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>,
+        preload?: string,
+        duration?: number,
+    ): void;
     loadBlob(url: Blob | File): void;
@@ -50,10 +68,15 @@ pause(): Promise<void> | undefined;
     playPause(): Promise<void> | undefined;
+    registerPlugins(plugins: WaveSurfer.PluginDefinition[]): WaveSurfer;
     seekAndCenter(progress: number): void;
     seekTo(progress: number): void;
+    setBackgroundColor(color: string): void;
+    setCurrentTime(seconds: number): void;
+    setCursorColor(color: string): void;
     setHeight(height: number): void;
+    setMute(mute: boolean): void;
     setPlaybackRate(rate: number): void;
+    setPlayEnd(position: number): void;
     setVolume(newVolume: number): void;
-    setMute(mute: boolean): void;
     setWaveColor(color: string): void;
-    setSinkId(deviceId: string): void;
+    setSinkId(deviceId: string): Promise<any>;
     skip(offset: number): void;
@@ -78,5 +101,20 @@ skipBackward(seconds?: number): void;
         destroy(): void;
-        drawBars(peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>, channelIndex: number, start: number, end: number): void;
-        drawPeaks(peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>, length: number, start: number, end: number): void;
-        drawWave(peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>, channelIndex: number, start: number, end: number): void;
+        drawBars(
+            peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>,
+            channelIndex: number,
+            start: number,
+            end: number,
+        ): void;
+        drawPeaks(
+            peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>,
+            length: number,
+            start: number,
+            end: number,
+        ): void;
+        drawWave(
+            peaks: ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>,
+            channelIndex: number,
+            start: number,
+            end: number,
+        ): void;
         getScrollX(): number;
@@ -121,7 +159,11 @@ getWidth(): number;
         autoCenter?: boolean;
-        backend?: string;
+        autoCenterRate?: number;
+        autoCenterImmediately?: boolean;
+        backend?: 'WebAudio' | 'MediaElement' | 'MediaElementWebAudio';
+        backgroundColor?: string;
         barHeight?: number;
+        barRadius?: number;
+        barGap?: number;
         barWidth?: number;
-        barGap?: number;
-        barRadius?: number;
+        barMinHeight?: number;
         closeAudioContext?: boolean;
@@ -131,2 +173,4 @@ container: string | HTMLElement;
         cursorWidth?: number;
+        drawingContextAttributes?: object;
+        duration?: number;
         fillParent?: boolean;
@@ -148,4 +192,5 @@ forceDecode?: boolean;
         removeMediaElementOnDestroy?: boolean;
-        renderer?: { new(container: HTMLElement, params: WaveSurferParams): WaveRenderer };
+        renderer?: { new (container: HTMLElement, params: WaveSurferParams): WaveRenderer };
         responsive?: boolean | number;
+        rtl?: boolean;
         scrollParent?: boolean;
@@ -163,3 +208,3 @@ skipLength?: number;
         params: object;
-        instance: { new(params: object, ws: WaveSurfer): WaveSurferPlugin };
+        instance: { new (params: object, ws: WaveSurfer): WaveSurferPlugin };
     }
@@ -182,2 +227,10 @@
     }
+
+    interface WaveSurferBackend {
+        getPeaks(
+            length: number,
+            first?: number,
+            last?: number,
+        ): ReadonlyArray<number> | ReadonlyArray<ReadonlyArray<number>>;
+    }
 }

wavesurfer.js/package.json

 {
     "name": "@types/wavesurfer.js",
-    "version": "3.2.0",
+    "version": "3.3.0",
     "description": "TypeScript definitions for wavesurfer.js",
@@ -16,2 +16,7 @@ "license": "MIT",
             "githubUsername": "kubk"
+        },
+        {
+            "name": "Ben Nordstrom",
+            "url": "https://github.com/bennordgengo",
+            "githubUsername": "bennordgengo"
         }
@@ -28,4 +33,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "ac1ccf558d358031eee53f3d0c5aacefad68b208ef52d0a9e3abd1844dd458fd",
+    "typesPublisherContentHash": "9b1c4d92aa1cb737aa0fb1e78ea5a65479b4c2aadc3116c65e8390d5b5716838",
     "typeScriptVersion": "2.8"
 }

wavesurfer.js/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Mon, 16 Dec 2019 13:29:16 GMT
+ * Last updated: Mon, 13 Apr 2020 20:07:45 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: `WaveSurfer`
 # Credits
-These definitions were written by Yusuke Higuchi (https://github.com/higuri), and Egor Gorbachev (https://github.com/kubk).
+These definitions were written by [Yusuke Higuchi](https://github.com/higuri), [Egor Gorbachev](https://github.com/kubk), and [Ben Nordstrom](https://github.com/bennordgengo).

No alert changes

Improved metrics

Total package byte prevSize

10592

increased by19.13%

Lines of code

214

increased by32.1%

No dependency changes