cb56cd44ca
* docs: beta initial commit * docs(oauth): finish initial tutorial * docs(oauth-tutorial): finish guide * docs(docusaurus): just log broken links * docs: re-organising beta * docs(beta): sort documents for sorting * docs: more re-structure * docs: more re-structure (2) * fix: more WIP * fix: more WIP * chore: more updates * chore: wip * chore: wip * fix lock file * docs(getting-started): credentials * chore: remove json-server file * chore: cleanup * remove mongodb from dev app * chore: cleanup * revert * chore: cleanup * chore: more cleanup changes Co-authored-by: Balázs Orbán <info@balazsorban.com>
2.4 KiB
id, title
| id | title |
|---|---|
| overview | Overview |
An Adapter in NextAuth.js connects your application to whatever database or backend system you want to use to store data for users, their accounts, sessions, etc. Adapters are optional, unless you need to persist user information in your own database, or you want to implement certain flows. The Email Provider requires an adapter to be able to save Verification Tokens.
:::tip
When using a database, you can still use JWT for session handling for fast access. See the session.strategy option. Read about the trade-offs of JWT in the FAQ.
:::
We have a list of official adapters that are distributed as their own packages under the @next-auth/{name}-adapter namespace. Their source code is available in their various adapters package directories at nextauthjs/next-auth.
Custom Adapter
If you have a database/backend that we don't officially support, you can create your own adapter. See the tutorial for creating a database Adapter for more information.
:::tip If you would like to see a new adapter in the official repository, please open a PR and we will help you to get it merged. Tell us if you are interested in becoming one of the maintainers of any of the official adapters. :::
Editor integration
Adapters are strongly typed, and they rely on the single Adapter interface imported from next-auth/adapters.
When writing your own custom Adapter in plain JavaScript, note that you can use JSDoc to get helpful editor hints and auto-completion like so:
/** @return { import("next-auth/adapters").Adapter } */
function MyAdapter() {
return {
// your adapter methods here
}
}
:::note This will work in code editors with a strong TypeScript integration like VSCode or WebStorm. It might not work if you're using more lightweight editors like VIM or Atom. :::