@vnodes/graphql
    Preparing search index...

    Interface GraphQLArgumentsHost

    interface GraphQLArgumentsHost {
        getArgByIndex<T = any>(index: number): T;
        getArgs<T = any>(): T;
        getContext<T = any>(): T;
        getInfo<T = any>(): T;
        getRoot<T = any>(): T;
        getType<TContext extends string = ContextType>(): TContext;
        switchToHttp(): HttpArgumentsHost;
        switchToRpc(): RpcArgumentsHost;
        switchToWs(): WsArgumentsHost;
    }

    Hierarchy

    • ArgumentsHost
      • GraphQLArgumentsHost

    Implemented by

    Index

    Methods

    getArgByIndex getArgs getContext getInfo getRoot getType switchToHttp switchToRpc switchToWs

    Methods

    • Returns a particular argument by index.

      Type Parameters

      • T = any

      Parameters

      • index: number

        index of argument to retrieve

      Returns T

    • Returns the array of arguments being passed to the handler.

      Type Parameters

      • T = any

      Returns T

    • Type Parameters

      • T = any

      Returns T

    • Type Parameters

      • T = any

      Returns T

    • Type Parameters

      • T = any

      Returns T

    • Returns the current execution context type (string)

      Type Parameters

      • TContext extends string = ContextType

      Returns TContext

    • Switch context to HTTP.

      Returns HttpArgumentsHost

      interface with methods to retrieve HTTP arguments

    • Switch context to RPC.

      Returns RpcArgumentsHost

      interface with methods to retrieve RPC arguments

    • Switch context to WebSockets.

      Returns WsArgumentsHost

      interface with methods to retrieve WebSockets arguments

    Settings

    Member Visibility

    On This Page

    Methods