@auth/kysely-adapter
Official Kysely adapter for Auth.js / NextAuth.js.
Installation
npm install @auth/kysely-adapter kysely
KyselyAuth<DB, T>
Wrapper over the original Kysely
class in order to validate the passed in
database interface. A regular Kysely instance may also be used, but wrapping
it ensures the database interface implements the fields that Auth.js
requires. When used with kysely-codegen
, the Codegen
type can be passed as
the second generic argument. The generated types will be used, and
KyselyAuth
will only verify that the correct fields exist.
Extends
Kysely
<DB
>
Type Parameters
Type Parameter | Default type |
---|---|
DB extends T | - |
T | Database |
Database
Properties
Account
Account: AdapterAccount;
Session
Session: AdapterSession;
User
User: AdapterUser;
VerificationToken
VerificationToken: VerificationToken;
Codegen
type Codegen = { [K in keyof Database]: { [J in keyof Database[K]]: unknown } };
format
const format: {
from: T;
to: T;
};
Type declaration
from()
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
object ? | Record <string , any > |
Returns
T
to()
Type Parameters
Type Parameter |
---|
T |
Parameters
Parameter | Type |
---|---|
object | Record <string , any > |
Returns
T
KyselyAdapter()
function KyselyAdapter(db): Adapter
Parameters
Parameter | Type |
---|---|
db | Kysely <Database > |