跳至內容
從 NextAuth.js v4 遷移嗎?請閱讀 我們的遷移指南.
API 參考@auth/unstorage-adapter

@auth/unstorage-adapter

Auth.js / NextAuth.js 的官方 Unstorage 适配器。

安裝

npm install unstorage @auth/unstorage-adapter

UnstorageAdapterOptions

這是 Unstorage 适配器選項的介面。

屬性

accountByUserIdPrefix?

optional accountByUserIdPrefix: string;

accountByUserId 鍵的前綴

accountKeyPrefix?

optional accountKeyPrefix: string;

account 鍵的前綴

authenticatorKeyPrefix?

optional authenticatorKeyPrefix: string;

authenticator 鍵的前綴

authenticatorUserKeyPrefix?

optional authenticatorUserKeyPrefix: string;

authenticator-by-user-id 鍵的前綴

baseKeyPrefix?

optional baseKeyPrefix: string;

您的鍵的基本前綴

emailKeyPrefix?

optional emailKeyPrefix: string;

emailKey 鍵的前綴

sessionByUserIdKeyPrefix?

optional sessionByUserIdKeyPrefix: string;

sessionByUserId 鍵的前綴

sessionKeyPrefix?

optional sessionKeyPrefix: string;

sessionKey 鍵的前綴

useItemRaw?

optional useItemRaw: boolean;

使用 getItemRaw/setItemRaw 而不是 getItem/setItem

這是一個實驗性功能。請查看 unjs/unstorage#142 以了解更多資訊。

userKeyPrefix?

optional userKeyPrefix: string;

user 鍵的前綴

verificationTokenKeyPrefix?

optional verificationTokenKeyPrefix: string;

verificationToken 鍵的前綴


defaultOptions

const defaultOptions: {
  accountByUserIdPrefix: "user:account:by-user-id:";
  accountKeyPrefix: "user:account:";
  authenticatorKeyPrefix: "authenticator:";
  authenticatorUserKeyPrefix: "authenticator:by-user-id:";
  baseKeyPrefix: "";
  emailKeyPrefix: "user:email:";
  sessionByUserIdKeyPrefix: "user:session:by-user-id:";
  sessionKeyPrefix: "user:session:";
  useItemRaw: false;
  userKeyPrefix: "user:";
  verificationTokenKeyPrefix: "user:token:";
};

類型宣告

accountByUserIdPrefix

accountByUserIdPrefix: string = "user:account:by-user-id:";

accountKeyPrefix

accountKeyPrefix: string = "user:account:";

authenticatorKeyPrefix

authenticatorKeyPrefix: string = "authenticator:";

authenticatorUserKeyPrefix

authenticatorUserKeyPrefix: string = "authenticator:by-user-id:";

baseKeyPrefix

baseKeyPrefix: string = "";

emailKeyPrefix

emailKeyPrefix: string = "user:email:";

sessionByUserIdKeyPrefix

sessionByUserIdKeyPrefix: string = "user:session:by-user-id:";

sessionKeyPrefix

sessionKeyPrefix: string = "user:session:";

useItemRaw

useItemRaw: boolean = false;

userKeyPrefix

userKeyPrefix: string = "user:";

verificationTokenKeyPrefix

verificationTokenKeyPrefix: string = "user:token:";

UnstorageAdapter()

UnstorageAdapter(storage, options): Adapter

參數

參數類型
storageStorage<StorageValue>
optionsUnstorageAdapterOptions

返回

Adapter


hydrateDates()

hydrateDates(json): any

參數

參數類型
jsonRecord<string, any>

返回

any

Auth.js © Balázs Orbán 和團隊 -2024