Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/helpers/jwt"

Index

Functions

Const accessToken

  • accessToken(accessToken: AccessToken): Promise<string>
  • Generate an access token

    Parameters

    Returns Promise<string>

Const apiKeyToken

  • apiKeyToken(apiKey: ApiKey): Promise<string>
  • Generate an API key JWT

    Parameters

    Returns Promise<string>

Const approveLocationToken

  • approveLocationToken(id: string, ipAddress: string): Promise<string>
  • Generate a new approve location JWT

    Parameters

    • id: string
    • ipAddress: string

    Returns Promise<string>

Const checkInvalidatedToken

  • checkInvalidatedToken(token: string): Promise<void>
  • Check if a token is invalidated in Redis

    Parameters

    • token: string

      JWT

    Returns Promise<void>

Const checkIpRestrictions

Const checkReferrerRestrictions

  • checkReferrerRestrictions(apiKey: ApiKeyResponse, domain: string): void
  • Parameters

    Returns void

Const emailVerificationToken

  • emailVerificationToken(id: string): Promise<string>
  • Generate a new email verification JWT

    Parameters

    • id: string

    Returns Promise<string>

Const generateToken

  • generateToken(payload: string | object | Buffer, expiresIn: string | number, subject: Tokens): Promise<string>
  • Generate a new JWT

    Parameters

    • payload: string | object | Buffer
    • expiresIn: string | number
    • subject: Tokens

    Returns Promise<string>

Const getLoginResponse

  • Get the token response after logging in a user

    Parameters

    Returns Promise<LoginResponse>

Const invalidateToken

  • invalidateToken(token: string): Promise<void>
  • Invalidate a JWT using Redis

    Parameters

    • token: string

      JWT

    Returns Promise<void>

Const loginToken

  • loginToken(user: User): Promise<string>
  • Generate a new login JWT

    Parameters

    Returns Promise<string>

Const passwordResetToken

  • passwordResetToken(id: string): Promise<string>
  • Generate a new password reset JWT

    Parameters

    • id: string

    Returns Promise<string>

Const postLoginTokens

  • postLoginTokens(user: User, locals: Locals, refreshTokenString?: undefined | string): Promise<object>
  • Parameters

    • user: User
    • locals: Locals
    • Optional refreshTokenString: undefined | string

    Returns Promise<object>

Const refreshToken

  • refreshToken(id: string): Promise<string>
  • Generate a new refresh JWT

    Parameters

    • id: string

    Returns Promise<string>

Const twoFactorToken

  • twoFactorToken(user: User): Promise<string>
  • Generate a new 2FA JWT

    Parameters

    Returns Promise<string>

Const verifyToken

Generated using TypeDoc