search

krakenjs / jwt-csrf

Stateless CSRF protection using jsonwebtoken (JWT)
Other
108 stars 22 forks source link

Added typings file for jwt-csrf #3

Open pauljlucas opened 8 years ago

pauljlucas commented 8 years ago

This PR is much smaller than it seems. I added a typings file for the 2 main jwt-csrf functions. To make these clean and not throw errors i had to include express typings and it's dependencies. I am not sure if it is helpful to have the typings on this repo but i figured before submitting to Definitely Typed (https://github.com/DefinitelyTyped/DefinitelyTyped) I should throw it to you to tweak to your liking.

If you are going to close this due to not feeling it necessary do please give me some comments on the typings/your blessing to submit it to Definitely Typed. Thanks!

Paul

mstuart commented 8 years ago

Hi @pauljlucas, give me a few days to mull it over. Not too familiar w/ typescript, but willing to give it a try. Thanks!

pauljlucas commented 8 years ago

@mstuart Some extra information: my adding of express and the other files was unnecessary it was purely so the definition file won't have an error. This file is needed though for someone to use jwt-csrf with typescript and just is the definition file for all of your functions. At least you can just keep the typings file for jwt-csrf at the root of the directory so if someone wants to use it they can pull it into their project.

mstuart commented 8 years ago

@pauljlucas Know of any other projects that include typings files?

I see there's a few repos that collect all of the typings files for major projects. Then, I saw a few build tasks that automatically generate these. Trying to get a feel for what others in the community are doing... haven't seen these as much.

pauljlucas commented 8 years ago

The community is moving towards a package manager type of approach that pulls them down from other repos. But the more i read up on modules it seems you just need to upload to the other repos that hold all of the typings and then in your repo you add a link to that:

https://github.com/typings/typings/blob/master/docs/faq.md#should-i-use-the-typings-field-in-packagejson

Currently typings is the go to and can be used just like npm:

https://github.com/typings/typings

Other than in the repo is seems like there are a few sources which is why i figured just putting it in the module would be easiest but that is the part im the most un sure of. This is the most popular of the sources seems to be the Definitely Typed repo where i was suggesting adding this file to after your team vetted it.

https://github.com/DefinitelyTyped/DefinitelyTyped

This may lead us to the decision of just not keep it in the repo and throw it on one of the repositories of typings but i would ask that if there are any other methods you would like exposed or anything that isnt clear to comment on it and ill clean it up before submitting to one of them.

bluepnume commented 5 years ago

Hello all.

This module is no longer being actively maintained as part of the krakenjs org. We will likely be closing this repo. If you want to take ownership of the repo and maintain it going forwards, please reach out to me.