Class GqlArgumentsHost

Hierarchy

ExecutionContextHost
- GqlArgumentsHost

Implements

GraphQLArgumentsHost

Index

Constructors

Methods

getArgByIndex getArgs getClass getContext getHandler getInfo getRoot getType setType switchToHttp switchToRpc switchToWs create

Constructors

constructor

new GqlArgumentsHost(
    args: any[],
    constructorRef?: Type<any> | null,
    handler?: Function | null,
): GqlArgumentsHost
Parameters
- args: any[]
- OptionalconstructorRef: Type<any> | null
- Optionalhandler: Function | null
Returns GqlArgumentsHost
Inherited from ExecutionContextHost.constructor
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:9

Methods

getArgByIndex

getArgByIndex<T = any>(index: number): T
Returns a particular argument by index.
Type Parameters
- T = any
Parameters
- index: number
  index of argument to retrieve
Returns T
Implementation of GraphQLArgumentsHost.getArgByIndex
Inherited from ExecutionContextHost.getArgByIndex
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:15

getArgs

getArgs<T = any>(): T
Returns the array of arguments being passed to the handler.
Type Parameters
- T = any
Returns T
Implementation of GraphQLArgumentsHost.getArgs
Overrides ExecutionContextHost.getArgs
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:12

getClass

getClass<T = any>(): Type<T>
Returns the type of the controller class which the current handler belongs to.
Type Parameters
- T = any
Returns Type<T>
Inherited from ExecutionContextHost.getClass
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:12

getContext

getContext<T = any>(): T
Type Parameters
- T = any
Returns T
Implementation of GraphQLArgumentsHost.getContext
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:13

getHandler

getHandler(): Function
Returns a reference to the handler (method) that will be invoked next in the request pipeline.

Returns Function
Inherited from ExecutionContextHost.getHandler
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:13

getInfo

getInfo<T = any>(): T
Type Parameters
- T = any
Returns T
Implementation of GraphQLArgumentsHost.getInfo
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:14

getRoot

getRoot<T = any>(): T
Type Parameters
- T = any
Returns T
Implementation of GraphQLArgumentsHost.getRoot
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:11

getType

getType<TContext extends string = ContextType>(): TContext
Returns the current execution context type (string)
Type Parameters
- TContext extends string = ContextType
Returns TContext
Implementation of GraphQLArgumentsHost.getType
Inherited from ExecutionContextHost.getType
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:11

setType

setType<TContext extends string = ContextType>(type: TContext): void
Type Parameters
- TContext extends string = ContextType
Parameters
- type: TContext
Returns void
Inherited from ExecutionContextHost.setType
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/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 GraphQLArgumentsHost.switchToHttp
Inherited from ExecutionContextHost.switchToHttp
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/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 GraphQLArgumentsHost.switchToRpc
Inherited from ExecutionContextHost.switchToRpc
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/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 GraphQLArgumentsHost.switchToWs
Inherited from ExecutionContextHost.switchToWs
- Defined in node_modules/.pnpm/@nestjs+core@11.1.17_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15.1_re_bppcm4irc6zqvzino275rxinxu/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:18

`Static`create

create(context: ArgumentsHost): GqlArgumentsHost
Parameters
- context: ArgumentsHost
Returns GqlArgumentsHost
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:10

Class GqlArgumentsHost

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GqlArgumentsHost

Methods

getArgByIndex

Type Parameters

Parameters

Returns T

getArgs

Type Parameters

Returns T

getClass

Type Parameters

Returns Type<T>

getContext

Type Parameters

Returns T

getHandler

Returns Function

getInfo

Type Parameters

Returns T

getRoot

Type Parameters

Returns T

getType

Type Parameters

Returns TContext

setType

Type Parameters

Parameters

Returns void

switchToHttp

Returns HttpArgumentsHost

switchToRpc

Returns RpcArgumentsHost

switchToWs

Returns WsArgumentsHost

Staticcreate

Parameters

Returns GqlArgumentsHost

Settings

On This Page

`Static`create