plugin type definition

Wavesurfer.js version(s)

v4.0.1

Browser and operating system version(s)

Chrome 84.0.4147.125, Windows 10 Pro

Code needed to reproduce the issue

Plugin example from (here)[https://wavesurfer-js.org/example/spectrogram/index.html] seems not working in typescript.

import Wavesurfer from 'wavesurfer.js'
let wavesurefer: Wavesurfer;
wavesurfer = Wavesurfer.create({
  ...
  plugins: [
    Wavesurfer.spectrogram.create({
      fftSamples: 2048,
      ...
    })
  ]
});

I saw PluginDefinitions are well described in index.d.ts as below:

interface PluginDefinition {
  name: String;
  staticProps?: object;
  deferInit?: boolean;
  params: object;
  instance: { new (params: object, ws: WaveSurfer): WaveSurferPlugin };
}

I saw documents and issues, but there are no available informations about name, staticProps and so on.

My question is how to use plugin in typescript, and any example about typescript and plugin would be appreciated.

[this-username-is-taken]

I was able to get the plugins to work with Typescript by doing the following:

1. Import the plugin directly from the dist folder: import SpectrogramPlugin from 'wavesurfer.js/dist/plugin/wavesurfer.spectrogram';
2. Use the plugin as described in the docs: var wavesurfer = WaveSurfer.create({ // wavesurfer options ... plugins: [ SpectrogramPlugin.create({ // plugin options ... }) ] });
3. Turn off TS7016 by adding "noImplicitAny": false to tsconfig.json.

Definitely not as ideal as having a proper Typescript definition, but at least I am now able to use the plugins.

[spicemix]

For examples of how to actually use the plugins etc in Typescript, see https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/wavesurfer.js/wavesurfer.js-tests.ts

I personally would not approve any new development that wanted to use Javascript rather than Typescript here in 2021. Thanks!