Fix typescript typings #80
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
auth0, please merge this! |
|
Please! Merge! |
AlexRex
approved these changes
May 14, 2019
igorsechyn
reviewed
Jun 1, 2019
index.d.ts
Outdated
|
|
||
| function koaJwtSecret(options: JwksRsa.Options): (name: string, scheme: string, options?: any) => void; | ||
| function hapiJwt2KeyAsync(options: HapiJwtOptions): (decodedToken: DecodedToken) => Promise<{ key: SigningKey }>; |
There was a problem hiding this comment.
(decodedToken: DecodedToken) => Promise<{ key: SigningKey }>;
this is actually wrong. it does not return a promise of SigningKey, they key property is just a string with the value. See:
- https://github.com/auth0/node-jwks-rsa/blob/master/src/integrations/hapi.js#L25
- https://github.com/auth0/node-jwks-rsa/blob/master/src/integrations/hapi.js#L58
I wrote a test for verifying the typings here #98
There was a problem hiding this comment.
Good catch, thanks! Fixed it.
luisrudge
suggested changes
Jun 3, 2019
| @@ -5,6 +5,7 @@ | |||
| "main": "lib/index.js", | |||
| "types": "index.d.ts", | |||
| "dependencies": { | |||
| "@types/express-jwt": "0.0.41", | |||
There was a problem hiding this comment.
this should be a dev dependency
There was a problem hiding this comment.
The TypeScript handbook recommends using dependencies, because otherwise consumers will have to install @types/express-jwt manually: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#dependencies
luisrudge
approved these changes
Jun 3, 2019
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The typescript typings are not really accurate at the moment. This fixes them. Note that jwt-express types should be listed in dependencies (as they are now) because we re-export a type from that package.
Incorporates #73, #69, #54.
Fixes #46, #28, #78, #75.