型別

最後更新


本頁列出套件匯出的全部 TypeScript 介面。

AuthData


簽入 Token 與存進 Refresh 資料的使用者資料。
  1. interface AuthData {
  2. id: string;
  3. name: string;
  4. email: string;
  5. thumbnail?: string;
  6. level?: number;
  7. role?: string;
  8. scope?: string[];
  9. }

id 會傳給 checkUserExists()。整個物件會序列化存入 Redis,續期後原樣作為 VerifyResult.data 回傳。

VerifyResult


VerifyJWT() 的回傳值,三個旗標的意義見驗證結果。
  1. interface VerifyResult {
  2. data?: AuthData;
  3. isAuth: boolean;
  4. isError: boolean;
  5. isGuest: boolean;
  6. }

TokenResult


CreateJWT() 的回傳值。
  1. interface TokenResult {
  2. token: string;
  3. refresh_id: string;
  4. }

RefreshData


存於 refresh:<refresh_id> 的 JSON 結構。
  1. interface RefreshData {
  2. data: AuthData;
  3. version: number;
  4. fp: string;
  5. expires_at: Date;
  6. issued_at: Date;
  7. }

JWTPayload


Access Token 解碼後的欄位:AuthData 加上 fp 與 refresh_id。續期簽發的 Token 另含 version。
  1. interface JWTPayload {
  2. id: string;
  3. name: string;
  4. email: string;
  5. thumbnail?: string;
  6. level?: number;
  7. role?: string;
  8. scope?: string[];
  9. fp: string;
  10. refresh_id: string;
  11. }

Config


init() 的參數,每個欄位的說明與預設值見設定。
  1. interface Config {
  2. publicKeyPath?: string;
  3. privateKeyPath?: string;
  4. publicKey?: string;
  5. privateKey?: string;
  6. accessTokenExpires: number;
  7. refreshTokenExpires: number;
  8. isProd: boolean;
  9. domain?: string;
  10. redis: {
  11. host: string;
  12. port: number;
  13. password?: string;
  14. db?: number;
  15. };
  16. checkUserExists: (userId: string) => Promise<boolean>;
  17. AccessTokenCookieKey: string;
  18. RefreshTokenCookieKey: string;
  19. }
EN