GraphiQL API Documentation
    Preparing search index...

    Type Alias GraphQLLanguageConfig

    For the monaco-graphql language worker, these must be specified in a custom webworker. see the readme.

    type GraphQLLanguageConfig = {
        completionSettings?: Omit<CompletionSettings, "uri">;
        customValidationRules?: ValidationRule[];
        externalFragmentDefinitions?: FragmentDefinitionNode[] | string;
        fillLeafsOnComplete?: boolean;
        parseOptions?: ParseOptions;
        parser?: typeof parse;
        schemaLoader?: SchemaLoader;
        schemas?: SchemaConfig[];
    }
    Index

    Properties

    completionSettings? customValidationRules? externalFragmentDefinitions? fillLeafsOnComplete? parseOptions? parser? schemaLoader? schemas?

    Properties

    completionSettings?: Omit<CompletionSettings, "uri">
    customValidationRules?: ValidationRule[]

    Custom validation rules following graphql ValidationRule signature

    externalFragmentDefinitions?: FragmentDefinitionNode[] | string

    External fragments to be used with completion and validation

    fillLeafsOnComplete?: boolean

    Should field leafs be automatically expanded & filled on autocomplete?

    NOTE: this can be annoying with required arguments

    use completionSettings.fillLeafsOnComplete instead

    parseOptions?: ParseOptions

    Custom options passed to parse, whether graphql parse by default or custom parser

    parser?: typeof parse

    Provide a parser that matches graphql parse() signature Used for internal document parsing operations for autocompletion and hover, graphql-language-service-parser is used via graphql-language-service-interface

    schemaLoader?: SchemaLoader

    Take a variety of schema inputs common for the language worker, and transform them to at least a schema if not other easily available implementations

    schemas?: SchemaConfig[]

    An array of schema configurations from which to match files for language features You can provide many formats, see the config for details!

    Settings

    Member Visibility

    On This Page

    Properties