Logo for jsDocs.io

apollo-server-module-graphiql

  • Version 1.4.0
  • Published
  • 28 kB
  • No dependencies
  • MIT license

Install

npm i apollo-server-module-graphiql
yarn add apollo-server-module-graphiql
pnpm add apollo-server-module-graphiql

Overview

GraphiQL renderer for Apollo GraphQL Server

Index

Functions

Type Aliases

Functions

function renderGraphiQL

renderGraphiQL: (data: GraphiQLData) => string;

    function resolveGraphiQLString

    resolveGraphiQLString: (
        query: any,
        options: GraphiQLData | Function,
        ...args: any[]
    ) => Promise<string>;

      Type Aliases

      type GraphiQLData

      type GraphiQLData = {
          endpointURL: string;
          subscriptionsEndpoint?: string;
          query?: string;
          variables?: Object;
          operationName?: string;
          result?: Object;
          passHeader?: string;
          editorTheme?: string;
          websocketConnectionParams?: Object;
          rewriteURL?: boolean;
      };

        Package Files (3)

        Dependencies (0)

        No dependencies.

        Dev Dependencies (0)

        No dev dependencies.

        Peer Dependencies (0)

        No peer dependencies.

        Badge

        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/apollo-server-module-graphiql.

        • Markdown
          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/apollo-server-module-graphiql)
        • HTML
          <a href="https://www.jsdocs.io/package/apollo-server-module-graphiql"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>