GraphiQL API Documentation
    Preparing search index...

    Module graphql-language-service

    graphql-language-service

    Changelog | API Docs | Discord

    Note: Still mostly experimental, however it depends mostly on stable libraries. Migration Note: As of 3.0.0, the LSP Server command line interface has been moved to graphql-language-service-cli

    This package brings together all the dependencies for building out web or desktop IDE services for the GraphQL Language.

    It is named as such to match the convention of other vscode language services.

    Language Service Protocol (LSP) methods written in TypeScript used by graphql-language-service-server, monaco-graphql and codemirror-graphql.

    The goal is to provide methods for creating Language Server Protocol compliant services to be used by an IDE plugin, a browser application or desktop application.

    A standalone online, immutable, dependency-free parser for GraphQL, used by the LSP interface methods

    Various utilities

    Namespaces

    CompletionItemKind

    Enumerations

    GraphQLDocumentMode

    Classes

    CharacterStream
    Position
    Range

    Interfaces

    CharacterStreamInterface
    GraphQLCache
    GraphQLConfig
    GraphQLProjectConfig
    IPosition
    IRange
    JSONSchema6

    Type Aliases

    AutocompleteSuggestionOptions
    CachedContent
    CompletionItem
    CompletionItemKind
    ContextToken
    ContextTokenForCodeMirror
    ContextTokenUnion
    Definition
    DefinitionQueryResponse
    DefinitionQueryResult
    Diagnostic
    FileChangeType
    FileChangeTypeKind
    FragmentInfo
    GraphQLExtensionDeclaration
    GraphQLFileInfo
    GraphQLFileMetadata
    HoverConfig
    JSONSchema6TypeName
    JSONSchemaOptions
    Maybe
    ObjectTypeInfo
    OperationFacts
    Outline
    OutlineTree
    ParserOptions
    ParseRule
    QueryFacts
    RuleKind
    RuleKindEnum
    RuleOrString
    Severity
    SeverityEnum
    State
    Token
    TokenPattern
    Uri
    VariableToType

    Variables

    DIAGNOSTIC_SEVERITY
    FileChangeTypeKind
    getQueryFacts
    LexRules
    ParseRules
    RuleKinds
    SEVERITY
    SuggestionCommand

    Functions

    canUseDirective
    collectVariables
    getASTNodeAtPosition
    getAutocompleteSuggestions
    getContextAtPosition
    getDefinitionQueryResultForArgument
    getDefinitionQueryResultForDefinitionNode
    getDefinitionQueryResultForField
    getDefinitionQueryResultForFragmentSpread
    getDefinitionQueryResultForNamedType
    getDefinitionState
    getDiagnostics
    getFieldDef
    getFragmentDefinitions
    getFragmentDependencies
    getFragmentDependenciesForAST
    getHoverInformation
    getOperationASTFacts
    getOperationFacts
    getOutline
    getRange
    getTokenAtPosition
    getTypeInfo
    getVariableCompletions
    getVariablesJSONSchema
    isIgnored
    list
    offsetToPosition
    onlineParser
    opt
    p
    pointToOffset
    t
    validateQuery
    validateWithCustomRules