clarify documentation comment for getTokenSilently #874
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.
Changes
This clarifies the documentation for
getTokenSilently
. I had to dig through the code a bit to find outif 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