コンテンツへスキップ
NextAuth.js v4 からの移行?はこちらをご覧ください 移行ガイド.
API リファレンス@auth/dynamodb-adapter

@auth/dynamodb-adapter

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

インストール

npm install next-auth @auth/dynamodb-adapter

DynamoDBAdapterOptions

プロパティ

indexName?

optional indexName: string;

indexPartitionKey?

optional indexPartitionKey: string;

indexSortKey?

optional indexSortKey: string;

partitionKey?

optional partitionKey: string;

sortKey?

optional sortKey: string;

tableName?

optional tableName: string;

format

const format: {
  from: null | T;
  to: Record<string, unknown>;
};

型宣言

from()

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

型パラメーター
型パラメーター
TRecord<string, unknown>
パラメーター
パラメーター
オブジェクト?Record<string, any>
戻り値

null | T

to()

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

パラメーター
パラメーター
オブジェクトRecord<string, any>
戻り値

Record<string, unknown>


DynamoDBAdapter()

DynamoDBAdapter(client, options?): Adapter

パラメーター

パラメーター
クライアントDynamoDBDocument
オプション?DynamoDBAdapterOptions

戻り値

アダプター


generateUpdateExpression()

generateUpdateExpression(object): {
  ExpressionAttributeNames: Record<string, string>;
  ExpressionAttributeValues: Record<string, unknown>;
  UpdateExpression: string;
}

パラメーター

パラメーター
オブジェクトRecord<string, any>

戻り値

{
  ExpressionAttributeNames: Record<string, string>;
  ExpressionAttributeValues: Record<string, unknown>;
  UpdateExpression: string;
}

ExpressionAttributeNames

ExpressionAttributeNames: Record<string, string>;

ExpressionAttributeValues

ExpressionAttributeValues: Record<string, unknown>;

UpdateExpression

UpdateExpression: string;
Auth.js © Balázs Orbán and Team -2024