GraphiQL API Documentation
    Preparing search index...

    Copyright (c) 2021 GraphQL Contributors All rights reserved.

    This source code is licensed under the license found in the LICENSE file in the root directory of this source tree.

    Index

    Constructors

    • Parameters

      • __namedParameters: {
            config?: GraphQLConfig;
            connection: Connection;
            fileExtensions: readonly (
                | ".js"
                | ".cjs"
                | ".mjs"
                | ".es"
                | ".esm"
                | ".es6"
                | ".ts"
                | ".jsx"
                | ".tsx"
                | ".vue"
                | ".svelte"
                | ".astro"
                | ".cts"
                | ".mts"
            )[];
            graphqlFileExtensions: string[];
            loadConfigOptions: LoadConfigOptions;
            logger: Logger
            | NoopLogger;
            parser?: (
                text: string,
                uri: string,
                fileExtensions?: readonly (
                    | ".js"
                    | ".cjs"
                    | ".mjs"
                    | ".es"
                    | ".esm"
                    | ".es6"
                    | ".ts"
                    | ".jsx"
                    | ".tsx"
                    | ".vue"
                    | ".svelte"
                    | ".astro"
                    | ".cts"
                    | ".mts"
                )[],
                graphQLFileExtensions?: string[],
                logger?: Logger | NoopLogger,
            ) => Promise<CachedContent[]>;
            tmpDir?: string;
        }
        • Optionalconfig?: GraphQLConfig
        • connection: Connection
        • fileExtensions: readonly (
              | ".js"
              | ".cjs"
              | ".mjs"
              | ".es"
              | ".esm"
              | ".es6"
              | ".ts"
              | ".jsx"
              | ".tsx"
              | ".vue"
              | ".svelte"
              | ".astro"
              | ".cts"
              | ".mts"
          )[]
        • graphqlFileExtensions: string[]
        • loadConfigOptions: LoadConfigOptions
        • logger: Logger | NoopLogger
        • Optionalparser?: (
              text: string,
              uri: string,
              fileExtensions?: readonly (
                  | ".js"
                  | ".cjs"
                  | ".mjs"
                  | ".es"
                  | ".esm"
                  | ".es6"
                  | ".ts"
                  | ".jsx"
                  | ".tsx"
                  | ".vue"
                  | ".svelte"
                  | ".astro"
                  | ".cts"
                  | ".mts"
              )[],
              graphQLFileExtensions?: string[],
              logger?: Logger | NoopLogger,
          ) => Promise<CachedContent[]>
        • OptionaltmpDir?: string

      Returns MessageProcessor

    Accessors

    Methods

    • Parameters

      • params: CompletionParams

      Returns Promise<CompletionList>

    • Parameters

      • params: TextDocumentPositionParams
      • Optional_token: CancellationToken

      Returns Promise<Location[]>

    • Parameters

      • _params: DidChangeConfigurationParams

      Returns Promise<DidChangeConfigurationRegistrationOptions>

    • Parameters

      • params: DidChangeTextDocumentParams

      Returns Promise<PublishDiagnosticsParams | null>

    • Parameters

      • params: DidCloseTextDocumentParams

      Returns void

    • Parameters

      • params: DidSaveTextDocumentParams | DidOpenTextDocumentParams

      Returns Promise<PublishDiagnosticsParams>

    • Parameters

      • params: DocumentSymbolParams

      Returns Promise<SymbolInformation[]>

    • Parameters

      • params: TextDocumentPositionParams

      Returns Promise<Hover | null>

    • Parameters

      • params: InitializeParams
      • Optional_token: CancellationToken
      • OptionalconfigDir: string

      Returns Promise<InitializeResult<any>>

    • Parameters

      • params: DidChangeWatchedFilesParams

      Returns Promise<(PublishDiagnosticsParams | undefined)[] | null>

    • Parameters

      • params: WorkspaceSymbolParams

      Returns Promise<SymbolInformation[]>