INestMicroservice
Interface describing Microservice Context.
interface INestMicroservice extends INestApplicationContext {
listen(): Promise<any>
useWebSocketAdapter(adapter: WebSocketAdapter<any, any, any>): this
useGlobalFilters(...filters: ExceptionFilter<any>[]): this
useGlobalPipes(...pipes: PipeTransform<any, any>[]): this
useGlobalInterceptors(...interceptors: NestInterceptor<any, any>[]): this
useGlobalGuards(...guards: CanActivate[]): this
close(): Promise<void>
// inherited from nest/packages/common/INestApplicationContext
select<T>(module: Type<T> | DynamicModule): INestApplicationContext
get<TInput = any, TResult = TInput>(typeOrToken: string | symbol | Function | Type<TInput>): TResult
resolve<TInput = any, TResult = TInput>(typeOrToken: string | symbol | Function | Type<TInput>): Promise<TResult>
registerRequestByContextId<T = any>(request: T, contextId: { id: number; }): void
close(): Promise<void>
useLogger(logger: false | LoggerService | LogLevel[]): void
flushLogs(): void
enableShutdownHooks(signals?: string[] | ShutdownSignal[]): this
init(): Promise<this>
}
Methods
listen() |
---|
Starts the microservice. |
ParametersThere are no parameters. Returns
|
useWebSocketAdapter() | ||||||
---|---|---|---|---|---|---|
Register Ws Adapter which will be used inside Gateways.
Use when you want to override default |
||||||
Parameters
Returns
|
useGlobalFilters() | ||||||
---|---|---|---|---|---|---|
Registers exception filters as global filters (will be used within every message pattern handler) |
||||||
Parameters
Returns
|
useGlobalPipes() | ||||||
---|---|---|---|---|---|---|
Registers pipes as global pipes (will be used within every message pattern handler) |
||||||
Parameters
Returns
|
useGlobalInterceptors() | ||||||
---|---|---|---|---|---|---|
Registers interceptors as global interceptors (will be used within every message pattern handler) |
||||||
Parameters
Returns
|
useGlobalGuards() | ||||||
---|---|---|---|---|---|---|
Registers guards as global guards (will be used within every message pattern handler) |
||||||
Parameters
Returns
|
close() |
---|
Terminates the application |
ParametersThere are no parameters. Returns
|