nlp.js icon indicating copy to clipboard operation
nlp.js copied to clipboard

Published 20 hours ago • verified publisher icon axa-group

@types/nlp.js

Open bvanheukelom opened this issue 4 years ago • 12 comments

Is your feature request related to a problem? Please describe. Typescript developers rely on type definitions for their IDEs to provide reliable autocompletes. This gives them the ability to discover the API of any given library a lot faster than by referring to documentation. nlp.js would be more accessible and find more adoption and be overall even more awesome than it already is.

Describe the solution you'd like Provide type definitions via Definitely Typed.

Describe alternatives you've considered Alternatives could be:

  1. An API documentation could be provided.
  2. Types could be added to the code. As typescript is a superset of javascript it could be done iteratively. This enhances the maintainability of the code as it allows for IDEs to help with refactoring. The code would have to be transpiled to javascript which would in turn generate the code as it is now or something very much similar.

Additional context https://github.com/DefinitelyTyped/DefinitelyTyped (31k Github Stars) http://earlbarr.com/publications/typestudy.pdf (Bugs can be found using Typescript) https://madnight.github.io/githut/#/pull_requests/2020/3 (7.5% of all repositories are Typescript. 20.17% of all repositories are Javascript) https://www.typescriptlang.org/ (Typescript website)

bvanheukelom avatar Dec 02 '20 21:12 bvanheukelom

This would be fabulous indeed

luddilo avatar Dec 19 '20 20:12 luddilo

+1

bobysf12 avatar Mar 15 '21 13:03 bobysf12

Very need it

maxbaluev avatar Mar 21 '21 21:03 maxbaluev

Please :)

burtonator avatar Jul 24 '21 23:07 burtonator

Where's the API documentation?

gcleaves avatar Apr 19 '22 15:04 gcleaves

+1

TheresaQWQ avatar Apr 21 '22 13:04 TheresaQWQ

+1

jBernavaPrah avatar Aug 04 '23 07:08 jBernavaPrah

+1

osenvosem avatar Aug 08 '23 15:08 osenvosem

:+1: :) this is really needed.

pacifiquem avatar Sep 14 '23 14:09 pacifiquem

PRs welcome I would assume ;-)

Apollon77 avatar Sep 17 '23 10:09 Apollon77

@Apollon77 Would you prefer .d.ts typings added to the project, or full-blown TS conversion?

kibertoad avatar Sep 20 '23 07:09 kibertoad

Honestly a full blown TS conversion would be "cool" but in my eyes unrealitsic to achieve (or at least an immense effort - but good it is a monorepo so in fact each package could be migrated one by one ... for a TS migration I'm personally also unsure for the risk because I donot know howcomplete the test coverage is really :-)

Said that I personally (but I have nothing to decide here, so just my opinion) would add typings as .d.ts files one by one in the relevant packages

Apollon77 avatar Sep 21 '23 08:09 Apollon77