Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify documentation comment for getTokenSilently #874

Merged
merged 4 commits into from
Feb 10, 2022
Merged

clarify documentation comment for getTokenSilently #874

merged 4 commits into from
Feb 10, 2022

Conversation

jdugan1024
Copy link
Contributor

Changes

This clarifies the documentation for getTokenSilently. I had to dig through the code a bit to find out
if would try to get a new token before the old one expired. Based on my reading of the code I updated
the docs to explain the behavior more clearly.

References

There is a comment in the code stating that it will try to get a new token 60 seconds before expiration: https://github.com/auth0/auth0-spa-js/blob/master/src/Auth0Client.ts#L1245

Testing

This is a documentation only change, so no tests were added or updated.

Checklist

@jdugan1024 jdugan1024 requested a review from a team as a code owner February 9, 2022 03:04
Copy link
Contributor

@stevehobbsdev stevehobbsdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution here, just left a couple of small tweaks and suggestions.

src/Auth0Client.ts Outdated Show resolved Hide resolved
src/Auth0Client.ts Outdated Show resolved Hide resolved
src/Auth0Client.ts Outdated Show resolved Hide resolved
jdugan1024 and others added 3 commits February 9, 2022 10:55
Co-authored-by: Steve Hobbs <steve.hobbs@hey.com>
Co-authored-by: Steve Hobbs <steve.hobbs@hey.com>
Co-authored-by: Steve Hobbs <steve.hobbs@hey.com>
@jdugan1024
Copy link
Contributor Author

@stevehobbsdev have committed all of your suggestions. Thanks for the quick turnaround on this!

Copy link
Contributor

@stevehobbsdev stevehobbsdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@stevehobbsdev stevehobbsdev merged commit 9b1e5fe into auth0:master Feb 10, 2022
@stevehobbsdev stevehobbsdev mentioned this pull request Feb 14, 2022
@jdugan1024 jdugan1024 deleted the clarify-get-token-silently-docs branch February 23, 2022 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants