node-jira-client
node-jira-client copied to clipboard
TypeScript Definition
Can you add TypeScript definitions?
- [ ] create the
index.d.ts
file - [ ] add
"typings": "./index.d.ts"
topackage.json
I don't have time to do this, but I'm not necessarily opposed to doing so. If you want to submit a PR for this, I'd be happy to look it over.
You can also see the typescript implementation in the jira-api-wrapper
library
You can also see the typescript implementation in the
jira-api-wrapper
library
@MrRefactoring I like your newly created project. It's pity you did not consider putting that effort in this project.
@dkokic I looked through several wrapper projects for jira api. Everywhere are asked to introduce support for typescript, but the amount of work in such projects is comparable to writing a new project. Therefore, it was decided to write a new project, initially supporting typescript.
At a minimum, current PRs would be incompatible with the project. And we would definitely get breaking changes.
It would also be necessary to rework the entire project, which is much more complicated and takes longer than developing modularly
There is currently a definition for this library on DefinitelyTyped, it works really well but is not 100% accurate, some methods (createVersion, updateVersion) are listed there as expecting a string, while looking at this library source code it seems they need an object.
rewriting in typescript?
Any estimates how much effort would be required to rewrite it in TS? Happy to support the effort, but would need guidance of some more experienced people.
I good place to start would be the following:
- Change
Jira.js
toJira.ts
and update the build npm script to use typescript (tsc) - Add input
Interface
s for theJiraApi
constructor and all methods