support notBefore and expiresIn as strings #364
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
c77055d to
a873f47
Compare
simoneb
reviewed
Aug 10, 2023
| @@ -27,9 +27,11 @@ Create a signer function by calling `createSigner` and providing one or more of | |||
|
|
|||
| - `mutatePayload`: If set to `true`, the original payload will be modified in place (via `Object.assign`) by the signing function. This is useful if you need a raw reference to the payload after claims have been applied to it but before it has been encoded into a token. Default is `false`. | |||
|
|
|||
| - `expiresIn`: Time span (in milliseconds) after which the token expires, added as the `exp` claim in the payload as defined by the [section 4.1.4 of RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4). This will override any existing value in the claim. | |||
| - `expiresIn`: Time span (in milliseconds or text describing time) after which the token expires, added as the `exp` claim in the payload as defined by the [section 4.1.4 of RFC 7519](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.4). This will override any existing value in the claim. | |||
There was a problem hiding this comment.
rather, or in addition to providing explicit example, mention the library we use to parse the string format of the time. it's a popular library so mentioning that one is more explanatory than providing explicit examples
test/signer.spec.js
Outdated
| @@ -355,6 +355,20 @@ test('it respects payload exp claim (if supplied), overriding the default expire | |||
| t.end() | |||
| }) | |||
|
|
|||
| test('it supports expiresIn as a string', t => { | |||
There was a problem hiding this comment.
minor: use async tests so you don't have to remember to call t.end to end the test. simply making the test function async achieves that. I appreciate you are complying with the existing convention in this codebase, but I prefer we update it to the new syntax. t.end is only useful when doing assertions in callbacks, which is a niche use case
|
Woah . That was quick 🔥 |
Closed
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.
Closes #363
uses https://github.com/lukeed/ms underneath
Had to adjust the tests, update the docs and implement the ms lib