Can't "yarn add @types/audio-decode" about audio-decode HOT 10 CLOSED

Nah, there's no types yet. You can add if you want!

from audio-decode.

How do you make this work in a typescript project then correctly?

from audio-decode.

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": false,
  }
}

in tsconfig.json

from audio-decode.

i hacked this quick types

declare module 'audio-decode' {
  function wav(data: Buffer): Promise<AudioBuffer>;
  function mp3(data: Buffer): Promise<AudioBuffer>;
  function flac(data: Buffer): Promise<AudioBuffer>;
  function opus(data: Buffer): Promise<AudioBuffer>;
  function qoa(data: Buffer): Promise<AudioBuffer>;
  function oga(data: Buffer): Promise<AudioBuffer>;
}

note: make a file called global.d.ts and put this there.
preferbly in d folder

from audio-decode.

Added jsdoc. Hope it will suffice

from audio-decode.

@dy it does not suffice. There are no types available, need to generate declaration files (which you should be able to do from the JSDoc you already wrote) or publish them on definitely typed. Let me know if you're looking for help here, I wouldn't mind putting up a PR.

from audio-decode.

Sure, PR is welcomed!

from audio-decode.

@dy unfortunately I won't be using this package anymore but I'm still happy to guide you through it if you want. The gist of it is that you'll need to generate .d.ts files with tsc and publish them alongside the .js files. In your case there's only one file you need to do that for: audio-decode.js. So, add typescript as a dev dependency, add a simple .tsconfig.json file that only includes that one file and has stuff like allowJs: true and declaration: true, and a prepare script (for example) that runs tsc to generate the audio-decode.d.ts file.

Alternatively, you could always simply maintain the types in a declaration file directly so that you don't need to generate them every time.

In any case, make sure to add a reference to the types in the package.json. Let me know if I can help with anything.

from audio-decode.

Ok, added. Thanks!

from audio-decode.

Glad I could help!

from audio-decode.