[SDK-2173] Expand on behaviour of checkSession in docs #666
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
stevehobbsdev
added
documentation
frederikprijck
requested changes
Dec 4, 2020
README.md
Outdated
| @@ -82,7 +82,7 @@ const auth0 = new Auth0Client({ | |||
|
|
|||
| //if you do this, you'll need to check the session yourself | |||
| try { | |||
| await getTokenSilently(); | |||
| await checkSession(); | |||
| } catch (error) { | |||
| if (error.error !== 'login_required') { | |||
There was a problem hiding this comment.
Isnt this a bit weird now? checkSession will never throw login_required (https://github.com/auth0/auth0-spa-js/blob/master/src/Auth0Client.ts#L575) as it is part of the RECOVERABLE_ERRORS https://github.com/auth0/auth0-spa-js/blob/master/src/constants.ts. So it will never throw login_required.
There was a problem hiding this comment.
Very true, let me revert
src/Auth0Client.ts
Outdated
| * It should be used for silently logging in the user when you instantiate the | ||
| * `Auth0Client` constructor. You should not need this if you are using the | ||
| * `createAuth0Client` factory. | ||
| * `createAuth0Client` factory. If you are using the `Auth0Client` constructor | ||
| * directly, you can use `checkSession` immediately afterwards to check login state. |
There was a problem hiding this comment.
This paragraph speaks about:
- using constructor
- not using constructor
- using constructor
I think it reads a bit weird. Could we keep the parts about using the constructor together?
There was a problem hiding this comment.
Good point. Actually I think we can just drop this second part.
added 2 commits
December 4, 2020 16:15
frederikprijck
approved these changes
Dec 5, 2020
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.
Modified the doc comments on
checkSessionto better explain its behaviour.Also updated the usage example in the readme from
getTokenSilentlytocheckSession.