-
Notifications
You must be signed in to change notification settings - Fork 51
Description
What is the issue about?
- Bug
- Feature request
- Usage question
- Documentation
- Contributing / Development
What part(s) of Essentia.js is involved?
- essentia.js-core (vanilla algorithms)
- essentia.js-model (machine learning algorithms)
- essentia.js-plot (plotting utility module)
- essentia.js-extractor (typical algorithm combinations utility)
Description
I'd like to propose improving TypeScript support for essentia.js by creating an @types/essentia.js package. Currently, essentia.js includes TypeScript definitions in node_modules/essentia.js/dist/core_api.d.ts, but these types are not automatically recognized by TypeScript without additional configuration in tsconfig.json.
Creating an @types/essentia.js package would enhance the developer experience by allowing TypeScript users to benefit from type definitions without any extra configuration.
Questions for maintainers:
Do you have any existing plans for improving TypeScript support?
Would you be open to the creation of an @types/essentia.js package?
If so, would you prefer to maintain this package within the essentia.js repository, or would you be comfortable with it being part of DefinitelyTyped?
Are there any specific considerations or challenges regarding the type definitions that I should be aware of?
I'm willing to contribute to this effort by preparing the necessary files for a DefinitelyTyped submission or by working on improvements within this repository, depending on your preference.
Steps to reproduce / Code snippets / Screenshots
System info
Essentia.js version: [0.1.3]
Node.js version: [20.3.1]
TypeScript version: [5.1.3]