58 lines
1.9 KiB
TypeScript
58 lines
1.9 KiB
TypeScript
import { ExceptionFilter } from './exceptions/exception-filter.interface';
|
|
import { CanActivate } from './features/can-activate.interface';
|
|
import { NestInterceptor } from './features/nest-interceptor.interface';
|
|
import { PipeTransform } from './features/pipe-transform.interface';
|
|
import { INestApplicationContext } from './nest-application-context.interface';
|
|
import { WebSocketAdapter } from './websockets/web-socket-adapter.interface';
|
|
/**
|
|
* Interface describing Microservice Context.
|
|
*
|
|
* @publicApi
|
|
*/
|
|
export interface INestMicroservice extends INestApplicationContext {
|
|
/**
|
|
* Starts the microservice.
|
|
*
|
|
* @returns {void}
|
|
*/
|
|
listen(): Promise<any>;
|
|
/**
|
|
* Register Ws Adapter which will be used inside Gateways.
|
|
* Use when you want to override default `socket.io` library.
|
|
*
|
|
* @param {WebSocketAdapter} adapter
|
|
* @returns {this}
|
|
*/
|
|
useWebSocketAdapter(adapter: WebSocketAdapter): this;
|
|
/**
|
|
* Registers exception filters as global filters (will be used within every message pattern handler)
|
|
*
|
|
* @param {...ExceptionFilter} filters
|
|
*/
|
|
useGlobalFilters(...filters: ExceptionFilter[]): this;
|
|
/**
|
|
* Registers pipes as global pipes (will be used within every message pattern handler)
|
|
*
|
|
* @param {...PipeTransform} pipes
|
|
*/
|
|
useGlobalPipes(...pipes: PipeTransform<any>[]): this;
|
|
/**
|
|
* Registers interceptors as global interceptors (will be used within every message pattern handler)
|
|
*
|
|
* @param {...NestInterceptor} interceptors
|
|
*/
|
|
useGlobalInterceptors(...interceptors: NestInterceptor[]): this;
|
|
/**
|
|
* Registers guards as global guards (will be used within every message pattern handler)
|
|
*
|
|
* @param {...CanActivate} guards
|
|
*/
|
|
useGlobalGuards(...guards: CanActivate[]): this;
|
|
/**
|
|
* Terminates the application
|
|
*
|
|
* @returns {Promise<void>}
|
|
*/
|
|
close(): Promise<void>;
|
|
}
|