Interface TgArgumentsHost

Hierarchy

ArgumentsHost
- TgArgumentsHost

Implemented by

Index

Methods

getArgByIndex getArgs getContext getNext getType switchToHttp switchToRpc switchToWs

Methods

getArgByIndex

getArgByIndex<T>(index): T
Returns a particular argument by index.
Type Parameters
- T = any
Parameters
- index: number
  
  index of argument to retrieve
Returns T
Inherited from ArgumentsHost.getArgByIndex
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:64

getArgs

getArgs<T>(): T
Returns the array of arguments being passed to the handler.
Type Parameters
- T extends any[] = any[]
Returns T
Inherited from ArgumentsHost.getArgs
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:59

getContext

getContext<T>(): T
Type Parameters
- T = any
Returns T
- Defined in lib/execution-context/tg-arguments-host.interface.ts:4

getNext

getNext<T>(): T
Type Parameters
- T = any
Returns T
- Defined in lib/execution-context/tg-arguments-host.interface.ts:5

getType

getType<TContext>(): TContext
Returns the current execution context type (string)
Type Parameters
- TContext extends string = ContextType
Returns TContext
Inherited from ArgumentsHost.getType
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:83

switchToHttp

switchToHttp(): HttpArgumentsHost
Switch context to HTTP.

Returns HttpArgumentsHost
interface with methods to retrieve HTTP arguments
Inherited from ArgumentsHost.switchToHttp
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:74

switchToRpc

switchToRpc(): RpcArgumentsHost
Switch context to RPC.

Returns RpcArgumentsHost
interface with methods to retrieve RPC arguments
Inherited from ArgumentsHost.switchToRpc
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:69

switchToWs

switchToWs(): WsArgumentsHost
Switch context to WebSockets.

Returns WsArgumentsHost
interface with methods to retrieve WebSockets arguments
Inherited from ArgumentsHost.switchToWs
- Defined in node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:79

Generated using TypeDoc