Class TelegrafArgumentsHost

Hierarchy

ExecutionContextHost
- TelegrafArgumentsHost

Implements

TgArgumentsHost

Index

Constructors

Methods

getArgByIndex getArgs getClass getContext getHandler getNext getType setType switchToHttp switchToRpc switchToWs create

Constructors

constructor

new TelegrafArgumentsHost(args, constructorRef?, handler?): TelegrafArgumentsHost
Parameters
- args: any[]
- Optional constructorRef: Type<any>
- Optional handler: Function
Returns TelegrafArgumentsHost
Inherited from ExecutionContextHost.constructor
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:9

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
Implementation of TgArgumentsHost.getArgByIndex

Inherited from ExecutionContextHost.getArgByIndex
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:15

getArgs

getArgs<T>(): T
Returns the array of arguments being passed to the handler.
Type Parameters
- T extends any[] = any[]
Returns T
Implementation of TgArgumentsHost.getArgs

Inherited from ExecutionContextHost.getArgs
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:14

getClass

getClass<T>(): Type<T>
Type Parameters
- T = any
Returns Type<T>
Inherited from ExecutionContextHost.getClass
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:12

getContext

getContext<T>(): T
Type Parameters
- T = any
Returns T
Implementation of TgArgumentsHost.getContext
- Defined in lib/execution-context/telegraf-arguments-host.ts:16

getHandler

getHandler(): Function
Returns Function
Inherited from ExecutionContextHost.getHandler
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:13

getNext

getNext<T>(): T
Type Parameters
- T = any
Returns T
Implementation of TgArgumentsHost.getNext
- Defined in lib/execution-context/telegraf-arguments-host.ts:20

getType

getType<TContext>(): TContext
Returns the current execution context type (string)
Type Parameters
- TContext extends string = ContextType
Returns TContext
Implementation of TgArgumentsHost.getType

Inherited from ExecutionContextHost.getType
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:11

setType

setType<TContext>(type): void
Type Parameters
- TContext extends string = ContextType
Parameters
- type: TContext
Returns void
Inherited from ExecutionContextHost.setType
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:10

switchToHttp

switchToHttp(): HttpArgumentsHost
Switch context to HTTP.

Returns HttpArgumentsHost
interface with methods to retrieve HTTP arguments
Implementation of TgArgumentsHost.switchToHttp

Inherited from ExecutionContextHost.switchToHttp
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:17

switchToRpc

switchToRpc(): RpcArgumentsHost
Switch context to RPC.

Returns RpcArgumentsHost
interface with methods to retrieve RPC arguments
Implementation of TgArgumentsHost.switchToRpc

Inherited from ExecutionContextHost.switchToRpc
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:16

switchToWs

switchToWs(): WsArgumentsHost
Switch context to WebSockets.

Returns WsArgumentsHost
interface with methods to retrieve WebSockets arguments
Implementation of TgArgumentsHost.switchToWs

Inherited from ExecutionContextHost.switchToWs
- Defined in node_modules/@nestjs/core/helpers/execution-context-host.d.ts:18

`Static` create

create(context): TelegrafArgumentsHost
Parameters
- context: ArgumentsHost
Returns TelegrafArgumentsHost
- Defined in lib/execution-context/telegraf-arguments-host.ts:9

Generated using TypeDoc