Logo for jsDocs.io

graphql-playground-html

  • Version 1.6.30
  • Published
  • 33.6 kB
  • 1 dependency
  • MIT license

Install

npm i graphql-playground-html
yarn add graphql-playground-html
pnpm add graphql-playground-html

Overview

GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration).

Index

Functions

Interfaces

Functions

function renderPlaygroundPage

renderPlaygroundPage: (options: RenderPageOptions) => string;

    Interfaces

    interface MiddlewareOptions

    interface MiddlewareOptions {}

      property codeTheme

      codeTheme?: EditorColours;

        property config

        config?: any;

          property endpoint

          endpoint?: string;

            property env

            env?: any;

              property schema

              schema?: IntrospectionResult;

                property settings

                settings?: Partial<ISettings>;

                  property subscriptionEndpoint

                  subscriptionEndpoint?: string;

                    property tabs

                    tabs?: Tab[];

                      property workspaceName

                      workspaceName?: string;

                        interface RenderPageOptions

                        interface RenderPageOptions extends MiddlewareOptions {}

                          property cdnUrl

                          cdnUrl?: string;

                            property env

                            env?: any;

                              property faviconUrl

                              faviconUrl?: string | null;

                                property title

                                title?: string;

                                  property version

                                  version?: string;

                                    Package Files (2)

                                    Dependencies (1)

                                    Dev Dependencies (3)

                                    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/graphql-playground-html.

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