Types

Last updated


This page lists every TypeScript interface the package exports.

AuthData


The user data signed into tokens and stored in refresh data.
  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 is passed to checkUserExists(). The whole object is serialized into Redis and returned unchanged as VerifyResult.data after a refresh.

VerifyResult


The return value of VerifyJWT(); see Verification Results for the flags.
  1. interface VerifyResult {
  2. data?: AuthData;
  3. isAuth: boolean;
  4. isError: boolean;
  5. isGuest: boolean;
  6. }

TokenResult


The return value of CreateJWT().
  1. interface TokenResult {
  2. token: string;
  3. refresh_id: string;
  4. }

RefreshData


The JSON stored at refresh:<refresh_id>.
  1. interface RefreshData {
  2. data: AuthData;
  3. version: number;
  4. fp: string;
  5. expires_at: Date;
  6. issued_at: Date;
  7. }

JWTPayload


The fields of a decoded Access Token: AuthData plus fp and refresh_id. Tokens issued by a refresh also carry 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


The init() argument; see Configuration for each field and its default.
  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. }
中文