Function AuthBasic

  • AuthBasic(): (<TFunction, Y>(target, propertyKey?, descriptor?) => void)

  • Returns (<TFunction, Y>(target, propertyKey?, descriptor?) => void)

      • <TFunction, Y>(target, propertyKey?, descriptor?): void

      • Type Parameters

        • TFunction extends Function
        • Y

        Parameters

        • target: object | TFunction
        • Optional propertyKey: string | symbol
        • Optional descriptor: TypedPropertyDescriptor<Y>

        Returns void

    Description

    Decorator that enables HTTP Basic Auth for a route handler. Combines Swagger's @ApiBasicAuth() with NestJS's @UseGuards(AuthGuardProvider).

    Example

    @AuthBasic()

Settings

Member Visibility

Theme