@auth/mongodb-adapter

Auth.js / NextAuth.js 用の公式 MongoDB アダプター。

インストール

npm install @auth/mongodb-adapter mongodb

pnpm add @auth/mongodb-adapter mongodb

yarn add @auth/mongodb-adapter mongodb

bun add @auth/mongodb-adapter mongodb

MongoDBAdapterOptions

これは MongoDB アダプターオプションのインターフェースです。

プロパティ

collections?

optional collections: {
  Accounts: string;
  Sessions: string;
  Users: string;
  VerificationTokens: string;
};

MongoDB コレクションの名前。

Accounts?

optional Accounts: string;

Sessions?

optional Sessions: string;

Users?

optional Users: string;

VerificationTokens?

optional VerificationTokens: string;

databaseName?

optional databaseName: string;

MongoDB データベースに付ける名前

onClose()?

optional onClose: (client) => Promise<void>;

MongoDB クライアントのクローズを管理するためのコールバック関数。これは、client が MongoClient | Promise<MongoClient> を返す関数として提供される場合に役立ちます。これにより、データベース接続のよりカスタマイズされた管理が可能になり、永続性、コンテナの再利用、および接続のクローズに関する問題に対処できます。

パラメーター

戻り値

Promise<void>

defaultCollections

const defaultCollections: Required<Required<MongoDBAdapterOptions>["collections"]>;

format

const format: {
  from: T;
  to: T & {
     _id: ObjectId;
  };
};

型宣言

from()

MongoDB オブジェクトを受け取り、プレーンな古い JavaScript オブジェクトを返します

型パラメーター

パラメーター

戻り値

T

to()

プレーンな古い JavaScript オブジェクトを受け取り、MongoDB オブジェクトに変換します

型パラメーター

パラメーター

戻り値

T & { _id: ObjectId; }

MongoDBAdapter()

MongoDBAdapter(client, options): Adapter

パラメーター

戻り値

アダプター