23 lines
815 B
TypeScript
23 lines
815 B
TypeScript
import { Observable } from 'rxjs';
|
|
import { ExecutionContext } from './execution-context.interface';
|
|
/**
|
|
* Interface defining the `canActivate()` function that must be implemented
|
|
* by a guard. Return value indicates whether or not the current request is
|
|
* allowed to proceed. Return can be either synchronous (`boolean`)
|
|
* or asynchronous (`Promise` or `Observable`).
|
|
*
|
|
* @see [Guards](https://docs.nestjs.com/guards)
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export interface CanActivate {
|
|
/**
|
|
* @param context Current execution context. Provides access to details about
|
|
* the current request pipeline.
|
|
*
|
|
* @returns Value indicating whether or not the current request is allowed to
|
|
* proceed.
|
|
*/
|
|
canActivate(context: ExecutionContext): boolean | Promise<boolean> | Observable<boolean>;
|
|
}
|