Module: adapters
The @auth/core/adapters module contains useful helpers that a database adapter
can incorporate in order to be compatible with Auth.js.
You can think of an adapter as a way to normalize database implementation details to a common interface
that Auth.js can use to interact with the database.
Auth.js supports 2 session strtategies to persist the login state of a user.
The default is to use a cookie + JWT
based session store (strategy: "jwt"),
but you can also use a database adapter to store the session in a database.
Auth.js currently does not implement federated logout. So even if the session is deleted from the database, the user will still be logged in to the provider. See this discussion for more information.
Installationβ
- npm
- yarn
- pnpm
npm install @auth/core
yarn add @auth/core
pnpm add @auth/core
Usageβ
Built-in adapters already implement this interface, so you likely won't need to implement it yourself. If you do, you can use the following example as a starting point.
// src/your-adapter.ts
import { type Adapter } from "@auth/core/adapters"
export function MyAdapter(options: any): Adapter {
// implement the adapter methods
}
// src/index.ts
import { MyAdapter } from "./your-adapter"
const response = Auth({
adapter: MyAdapter({ ...adapter options }),
... auth options
})
Type Aliasesβ
Adapterβ
Ζ¬ Adapter<WithVerificationToken>: DefaultAdapter & WithVerificationToken extends true ? { createVerificationToken: (verificationToken: VerificationToken) => Awaitable<VerificationToken | null | undefined> ; useVerificationToken: (params: { identifier: string ; token: string }) => Awaitable<VerificationToken | null> } : {}
Using a custom adapter you can connect to any database backend or even several different databases. Custom adapters created and maintained by our community can be found in the adapters repository. Feel free to add a custom adapter from your project to the repository, or even become a maintainer of a certain adapter. Custom adapters can still be created and used in a project without being added to the repository.
Useful resourcesβ
See
Type parametersβ
| Name | Type |
|---|---|
WithVerificationToken | boolean |
Interfacesβ
AdapterSessionβ
β’ AdapterSession: Object
The session object implementing this interface is is used to look up the user in the database.