Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphQLHandler

A {@link Route} handler for GraphQL requests.

Hierarchy

  • GraphQLHandler

Implements

  • any

Index

Methods

Methods

beforeExecute

dataLoaderRegistry

  • dataLoaderRegistry(factory: (arg: RoutingContext) => any): GraphQLHandler

  • Customize the . The provided factory method will be invoked for each incoming GraphQL request.

    Parameters

    • factory: (arg: RoutingContext) => any
        • (arg: RoutingContext): any

        • Parameters

          • arg: RoutingContext

          Returns any

    Returns GraphQLHandler

handle

  • handle(arg0: RoutingContext): void

  • Parameters

    • arg0: RoutingContext

    Returns void

locale

  • Customize the passed to the GraphQL execution engine. The provided factory method will be invoked for each incoming GraphQL request.

    Parameters

    • factory: (arg: RoutingContext) => any
        • (arg: RoutingContext): any

        • Parameters

          • arg: RoutingContext

          Returns any

    Returns GraphQLHandler

queryContext

  • Customize the query context object. The provided factory method will be invoked for each incoming GraphQL request.

    Parameters

    • factory: (arg: RoutingContext) => any
        • (arg: RoutingContext): any

        • Parameters

          • arg: RoutingContext

          Returns any

    Returns GraphQLHandler

Static create

  • Create a new GraphQLHandler that will use the provided graphQL object to execute queries.

    The handler will be configured with default options.

    Parameters

    Returns GraphQLHandler

  • Create a new GraphQLHandler that will use the provided graphQL object to execute queries.

    The handler will be configured with the given options.

    Parameters

    Returns GraphQLHandler

Static getRoutingContext

  • getRoutingContext(graphQlContext: any): RoutingContext

  • Retrieves the from the .

    Parameters

    • graphQlContext: any

    Returns RoutingContext

Generated using TypeDoc