@auth/nats-kv-adapter
Official NATS KeyValue adapter for Auth.js / NextAuth.js.
Installation
npm install @nats-io/kv @nats-io/transport-node @auth/nats-kv-adapterNatsKVAdapterOptions
This is the interface of the Nats KV adapter options.
Properties
accountByUserIdPrefix?
optional accountByUserIdPrefix: string;The prefix for the accountByUserId key
accountKeyPrefix?
optional accountKeyPrefix: string;The prefix for the account key
baseKeyPrefix?
optional baseKeyPrefix: string;The base prefix for your keys
emailKeyPrefix?
optional emailKeyPrefix: string;The prefix for the emailKey key
sessionByUserIdKeyPrefix?
optional sessionByUserIdKeyPrefix: string;The prefix for the sessionByUserId key
sessionKeyPrefix?
optional sessionKeyPrefix: string;The prefix for the sessionKey key
userKeyPrefix?
optional userKeyPrefix: string;The prefix for the user key
verificationTokenKeyPrefix?
optional verificationTokenKeyPrefix: string;The prefix for the verificationToken key
defaultOptions
const defaultOptions: {
accountByUserIdPrefix: string;
accountKeyPrefix: string;
baseKeyPrefix: string;
emailKeyPrefix: string;
sessionByUserIdKeyPrefix: string;
sessionKeyPrefix: string;
userKeyPrefix: string;
verificationTokenKeyPrefix: string;
};Type declaration
accountByUserIdPrefix
accountByUserIdPrefix: string = "user.account.by-user-id.";accountKeyPrefix
accountKeyPrefix: string = "user.account.";baseKeyPrefix
baseKeyPrefix: string = "";emailKeyPrefix
emailKeyPrefix: string = "user.email.";sessionByUserIdKeyPrefix
sessionByUserIdKeyPrefix: string = "user.session.by-user-id.";sessionKeyPrefix
sessionKeyPrefix: string = "user.session.";userKeyPrefix
userKeyPrefix: string = "user.";verificationTokenKeyPrefix
verificationTokenKeyPrefix: string = "user.token.";hydrateDates()
function hydrateDates(json): anyParameters
| Parameter | Type |
|---|---|
json | object |
Returns
any
nats2json()
function nats2json(value): anyParameters
| Parameter | Type |
|---|---|
value | any |
Returns
any
natsKey()
function natsKey(identifier): stringParameters
| Parameter | Type |
|---|---|
identifier | string |
Returns
string
NatsKVAdapter()
function NatsKVAdapter(natsConnect, options): AdapterParameters
| Parameter | Type |
|---|---|
natsConnect | | KV | () => Promise<{ kv: KV; } & { [asyncDispose]: () => Promise<void>; }> |
options | NatsKVAdapterOptions |