supabase / supabase-flutter

Flutter integration for Supabase. This package makes it simple for developers to build secure and scalable products.
https://supabase.com/
MIT License
661 stars 154 forks source link

docs: Fixed imprecision in Custom Local Storage README.md #853

Closed alessandrobelottidev closed 3 months ago

alessandrobelottidev commented 3 months ago

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.