Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update API docs about server-side getProviders #879

Merged
merged 2 commits into from Dec 5, 2020
Merged

docs: update API docs about server-side getProviders #879

merged 2 commits into from Dec 5, 2020

Conversation

mingcenwei
Copy link
Contributor

Server-side getProviders accepts zero parameter just as the client-side one. Currently the docs write const providers = await getProviders({ req }), which is confusing. If the user uses @types/next-auth, she/he will find that the type signature of getProviders is () => Promise<GetProvidersResponse | null> instead of (context?: NextContext) => Promise<GetProvidersResponse | null>

server-side `getProviders` accept no params just as client-side
@vercel
Copy link

vercel bot commented Nov 24, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/nextauthjs/next-auth/i6xu2t7xq
✅ Preview: https://next-auth-git-main.nextauthjs.vercel.app

@vercel vercel bot temporarily deployed to Preview November 24, 2020 20:09 Inactive
Move the `note` section to the back of the `code` section
@vercel vercel bot temporarily deployed to Preview November 24, 2020 20:13 Inactive
@balazsorban44 balazsorban44 added the documentation Relates to documentation label Dec 5, 2020
@balazsorban44 balazsorban44 changed the title Update API docs about server-side getProviders docs: update API docs about server-side getProviders Dec 5, 2020
@balazsorban44 balazsorban44 merged commit 29a0d9d into nextauthjs:main Dec 5, 2020
@github-actions
Copy link

github-actions bot commented Feb 1, 2021

🎉 This PR is included in version 3.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants