@auth/sequelize-adapter
Official Sequilize adapter for Auth.js / NextAuth.js.
Installation
npm install next-auth @auth/sequelize-adapter sequelize
SequelizeAdapterOptions
This is the interface of the Sequelize adapter options.
Properties
associations()?
optional associations: (User, Account, Session, VerificationToken) => void;
Override the default model associations
Default Associations:
Account.belongsTo(User, { onDelete: "cascade" })
Session.belongsTo(User, { onDelete: "cascade" })
Example:
(User, Account, Session) => {
Account.belongsTo(User, { onDelete: "cascade", foreignKey: "userId", as: 'user' });
Session.belongsTo(User, { onDelete: "cascade", foreignKey: "userId", as: 'user' });
}
Parameters
Parameter | Type |
---|---|
User | ModelCtor <UserInstance > |
Account | ModelCtor <AccountInstance > |
Session | ModelCtor <SessionInstance > |
VerificationToken | ModelCtor <VerificationTokenInstance > |
Returns
void
models?
optional models: Partial<{
Account: ModelCtor<AccountInstance>;
Session: ModelCtor<SessionInstance>;
User: ModelCtor<UserInstance>;
VerificationToken: ModelCtor<VerificationTokenInstance>;
}>;
The Sequelize Models related to Auth.js that will be created in your database.
synchronize?
optional synchronize: boolean;
Whether to synchronize the models or not.
default()
function default(client, options?): Adapter
Parameters
Parameter | Type |
---|---|
client | Sequelize |
options ? | SequelizeAdapterOptions |
Returns
models
Re-exports models