docs: Fixed imprecision in Custom Local Storage README.md #853
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
The README.md is not completely precise when providing an example of a Custom Local Storage. To check if it hasAccessToken it should return a bool (and so should return storage.containsKey(key: supabasePersistSessionKey) ). And when retrieving the accessToken it should return a string (so the correct code would be: storage.read(key: supabasePersistSessionKey) )
alessandrobelottidev
changed the title
dshukertjr
approved these changes
Mar 10, 2024
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 README.md is not completely precise when providing an example of a Custom Local Storage.
To check if it hasAccessToken it should return a bool (and so should return storage.containsKey(key: supabasePersistSessionKey) ).
And when retrieving the accessToken it should return a string (so the correct code would be: storage.read(key: supabasePersistSessionKey) )
What kind of change does this PR introduce?
Docs update
What is the current behavior?
The two functions accessToken() and hasAccessToken() return the wrong type. It's probably simply an oversight when copy-pasting this code.
What is the new behavior?
I swapped the two return lines so that it behaves correctly.
Additional context
When trying to understand how to create a custom local storage I spent some time figuring out why my code was not behaving correctly, but then saw the wrong return type.
Im new to the open source community so I don't know if Im contributing correctly and if I explained myself correctly in this PR.