Function logoutHandler

  • logoutHandler(refreshTokenService, logger, context): Promise<{
        status: StatusCodes;
    }>

  • Create logout handler

    Parameters

    • refreshTokenService: undefined | RefreshTokenService

      injected service use to handle the refresh token related operations

      • deleteRefreshToken
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<{
        status: StatusCodes;
    }>

    204 Status No Content

    Description

    This handler will create logout by applying the following steps in sequence:

    1. Get userId from context

    2. Get cookies from request

    3. Set cookie maxAge to 0

    4. Delete refresh token from refresh token service (refreshTokenService.deleteRefreshToken)

    Note: This handler only handle when use cookie authType

    Throws

    400 NBError Bad Request

    • userId is undefined
    • cookies is undefined in request

    Throws

    500 NBError Internal Server Error

    • required information is undefined
    • refreshTokenService is undefined

Settings

Member Visibility

Theme

Generated using TypeDoc