vertx-graphql/index.d.ts

Create a GraphQL HTTP Server with Vert.x

/*
 * Copyright 2018 vertx-graphql
 *
 * Vertx-GraphQL licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

import { Router } from '@vertx/web';

interface Tab {
  endpoint?: string,
  query?: string
}

interface GraphQLServerOptions {
  typeDefs: string,
  resolvers: object,
  context?: object,
  playground?: {
    settings?: {
      'editor.theme'?: string,
    },
    tabs?: Array<Tab>
  },
  introspection?: boolean,
  graphiql?: {
    settings?: {
      'editor.theme'?: string,
    },
    defaultQuery?: string,
  }
}

interface GraphQLMiddlewareOptions {
  app: Router,
  path: string
}

export class GraphQLServer {
  constructor(options: GraphQLServerOptions) : void;

  public graphqlPath: string;
  public subscriptionsPath: string;

  applyMiddleware(options: GraphQLMiddlewareOptions): void
  installSubscriptionHandlers(app: Router): void
}