docs: renamed createClient functions to prevent IDE import mistakes #26275
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
|
@FocusCookie is attempting to deploy a commit to the Supabase Team on Vercel. A member of the Team first needs to authorize it. |
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.
I have read the CONTRIBUTING.md file.
YES
What kind of change does this PR introduce?
docs update
What is the current behavior?
The next current examples for the usage of the several createClients in the
nextjs & @supabase/ssr examples could lead to potential miss imports of the wrong createClient for a given situation.
For example, an import of the createClient from the client.ts in a server component will not throw an error. This potentially causing unexpected behavior.
I had that issue for hours, and I was wondering why my RLS is not working as I expected.
What is the new behavior?
The doc file is being updated in order that every createClient for the instructed files has a unique name.
Feel free to include screenshots if it includes visual changes.