Interface ITokenService

Token service interface

interface ITokenService {
    generateToken(data: TokenData, expiresIn: string): string;
    getData(accessToken: string): Promise<TokenData>;
    refreshToken(refreshToken: string): Promise<string>;
    validateToken(accessToken: string): Promise<boolean>;
}

Implemented by

Methods

generateToken getData refreshToken validateToken

Methods

generateToken

  • generateToken(data, expiresIn): string

  • Generates a new token

    Parameters

    • data: TokenData

      The data to encode in the token

    • expiresIn: string

      The token expiration time

    Returns string

    The generated token

getData

  • getData(accessToken): Promise<TokenData>

  • Gets the data from an access token

    Parameters

    • accessToken: string

      The access token

    Returns Promise<TokenData>

    The token data

    Throws

    If the token is not provided

    Throws

    If the token is invalid

    Throws

    If the token is expired

refreshToken

  • refreshToken(refreshToken): Promise<string>

  • Generates a new access token

    Parameters

    • refreshToken: string

      The refresh token

    Returns Promise<string>

    The new access token

    Throws

    If the refresh token is invalid

    Throws

    If the refresh token is expired

validateToken

  • validateToken(accessToken): Promise<boolean>

  • Validates an access token

    Parameters

    • accessToken: string

      The access token

    Returns Promise<boolean>

    Whether the token is valid

    Throws

    If the token is not provided

Settings

Member Visibility

On This Page

Methods