@tsed/common/lib/mvc/decorators/method/useAuth.d.ts

A TypeScript Framework on top of Express

import { Type } from "@tsed/core";
import { IAuthOptions } from "./authOptions";
/**
 * Use custom authentication strategy on your endpoint.
 *
 * ```typescript
 * @Controller('/mypath')
 * @UseAuth(MyAuthStrategy)
 * class MyCtrl {
 *
 *   @Get('/')
 *   @UseAuth(MyAuthStrategy, {role: 'admin'})
 *   public getResource(){}
 * }
 * ```
 *
 * @param guardAuth {Type<any>} A middleware which implement a custom auth strategy
 * @param options {Object} Object passed to the customer auth strategy
 * @returns {Function}
 * @decorator
 * @operation
 */
export declare function UseAuth(guardAuth: Type<any>, options?: IAuthOptions): Function;