Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Enhance TypeScript support with @types/essentia.js #146

Open
3 of 9 tasks
rolldeep-stepmerrily opened this issue Sep 6, 2024 · 0 comments
Open
3 of 9 tasks

Comments

@rolldeep-stepmerrily
Copy link

rolldeep-stepmerrily commented Sep 6, 2024

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]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant