Class GraphiQLHandler

A {@link Route} handler for GraphiQL resources.

Hierarchy

GraphiQLHandler

Implements

any

Index

Methods

Methods

graphiQLRequestHeaders

graphiQLRequestHeaders(factory: (arg: RoutingContext) => MultiMap): GraphiQLHandler

- Defined in io.vertx/vertx-web-graphql/target/npm/index.d.ts:844
Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface. The result will be applied on top of the fixed set of headers specified in GraphiQLHandlerOptions.

This can be useful if, for example, the server is protected by authentication.

Parameters
- factory: (arg: RoutingContext) => MultiMap
  - - (arg: RoutingContext): MultiMap
    - Parameters
      - arg: RoutingContext
      Returns MultiMap
Returns GraphiQLHandler

handle

handle(arg0: RoutingContext): void

- Defined in io.vertx/vertx-web-graphql/target/npm/index.d.ts:822
Parameters
- arg0: RoutingContext
Returns void

Static create

create(): GraphiQLHandler
create(options: GraphiQLHandlerOptions): GraphiQLHandler

- Defined in io.vertx/vertx-web-graphql/target/npm/index.d.ts:829
Create a new GraphiQLHandler.

The handler will be configured with default options.

Returns GraphiQLHandler
- Defined in io.vertx/vertx-web-graphql/target/npm/index.d.ts:836
Create a new GraphiQLHandler.

The handler will be configured with the given options.

Parameters
- options: GraphiQLHandlerOptions
Returns GraphiQLHandler

Generated using TypeDoc