@auth/dynamodb-adapter
Official DynamoDB adapter for Auth.js / NextAuth.js.
Installation
npm install next-auth @auth/dynamodb-adapterDynamoDBAdapterOptions
Properties
entitySlugs?
optional entitySlugs: DynamoDBEntityTypeOptions;entityTagName?
optional entityTagName: string;entityTags?
optional entityTags: DynamoDBEntityTypeOptions;indexName?
optional indexName: string;indexPartitionKey?
optional indexPartitionKey: string;indexSortKey?
optional indexSortKey: string;partitionKey?
optional partitionKey: string;sortKey?
optional sortKey: string;tableName?
optional tableName: string;DynamoDBEntityTypeOptions
Properties
account?
optional account: string;session?
optional session: string;user?
optional user: string;vt?
optional vt: string;format
const format: {
from: <T>(object?) => T | null;
to: Record<string, unknown>;
};Type declaration
from()
Takes a set of options; Returns a function that takes a Dynamo object and returns a plain old JavaScript object
Parameters
| Parameter | Type |
|---|---|
formatOptions | DynamoDBAdapterFormatOptions |
Returns
Function
Type parameters
Type parameter Value TRecord<string,unknown>Parameters
Parameter Type object?Record<string,any>Returns
T|null
to()
Takes a plain old JavaScript object and turns it into a DynamoDB object
Parameters
| Parameter | Type |
|---|---|
object | Record<string, any> |
Returns
Record<string, unknown>
DynamoDBAdapter()
DynamoDBAdapter(client, options?): AdapterParameters
| Parameter | Type |
|---|---|
client | DynamoDBDocument |
options? | DynamoDBAdapterOptions |
Returns
generateUpdateExpression()
generateUpdateExpression(object): {
ExpressionAttributeNames: Record<string, string>;
ExpressionAttributeValues: Record<string, unknown>;
UpdateExpression: string;
}Parameters
| Parameter | Type |
|---|---|
object | Record<string, any> |
Returns
{
ExpressionAttributeNames: Record<string, string>;
ExpressionAttributeValues: Record<string, unknown>;
UpdateExpression: string;
}ExpressionAttributeNames
ExpressionAttributeNames: Record<string, string>;ExpressionAttributeValues
ExpressionAttributeValues: Record<string, unknown>;UpdateExpression
UpdateExpression: string;