MessageProcessor | GraphQL Official LSP Documentation

Hierarchy

MessageProcessor

Index

Constructors

constructor

Properties

Accessors

connection

Methods

Constructors

constructor

new MessageProcessor(__namedParameters: { config: undefined | GraphQLConfig; connection: Connection; fileExtensions: ReadonlyArray<".js" | ".cjs" | ".mjs" | ".es" | ".esm" | ".es6" | ".ts" | ".jsx" | ".tsx" | ".vue" | ".svelte" | ".astro" | ".cts" | ".mts">; graphqlFileExtensions: string[]; loadConfigOptions: LoadConfigOptions; logger: Logger | NoopLogger; parser: undefined | parseDocument; tmpDir: undefined | string }): MessageProcessor

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:109
Parameters
- __namedParameters: { config: undefined | GraphQLConfig; connection: Connection; fileExtensions: ReadonlyArray<".js" | ".cjs" | ".mjs" | ".es" | ".esm" | ".es6" | ".ts" | ".jsx" | ".tsx" | ".vue" | ".svelte" | ".astro" | ".cts" | ".mts">; graphqlFileExtensions: string[]; loadConfigOptions: LoadConfigOptions; logger: Logger | NoopLogger; parser: undefined | parseDocument; tmpDir: undefined | string }
  - config: undefined | GraphQLConfig
  - connection: Connection
  - fileExtensions: ReadonlyArray<".js" | ".cjs" | ".mjs" | ".es" | ".esm" | ".es6" | ".ts" | ".jsx" | ".tsx" | ".vue" | ".svelte" | ".astro" | ".cts" | ".mts">
  - graphqlFileExtensions: string[]
  - loadConfigOptions: LoadConfigOptions
  - logger: Logger | NoopLogger
  - parser: undefined | parseDocument
  - tmpDir: undefined | string
Returns MessageProcessor

Properties

_connection

_connection: Connection

Optional _extensions

_extensions: GraphQLExtensionDeclaration[]

_graphQLCache

_graphQLCache: GraphQLCache

_graphQLConfig

_graphQLConfig: GraphQLConfig | undefined

_isGraphQLConfigMissing

_isGraphQLConfigMissing: boolean | null = null

_isInitialized

_isInitialized: boolean = false

_languageService

_languageService: GraphQLLanguageService

_loadConfigOptions

_loadConfigOptions: LoadConfigOptions

_logger

_logger: Logger | NoopLogger

_parser

_parser: (text: string, uri: string) => CachedContent[]

Type declaration

- (text: string, uri: string): CachedContent[]
- Parameters
  - text: string
  - uri: string
  Returns CachedContent[]

_rootPath

_rootPath: string = process.cwd()

_schemaCacheInit

_schemaCacheInit: boolean = false

_settings

_settings: any

_textDocumentCache

_textDocumentCache: Map<string, CachedDocumentType> = new Map<string, CachedDocumentType>()

_tmpDir

_tmpDir: string

_tmpDirBase

_tmpDirBase: string

_tmpUriBase

_tmpUriBase: string

_willShutdown

_willShutdown: boolean = false

Accessors

connection

get connection(): Connection
set connection(connection: Connection): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:153
Returns Connection
- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:156
Parameters
- connection: Connection
Returns void

Methods

_cacheAllProjectFiles

_cacheAllProjectFiles(config: GraphQLConfig): Promise<undefined | void[]>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1155
This should only be run on initialize() really. Caching all the document files upfront could be expensive.

Parameters
- config: GraphQLConfig
Returns Promise<undefined | void[]>

_cacheArraySchema

_cacheArraySchema(pointers: UnnormalizedTypeDefPointer[], project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1018
Parameters
- pointers: UnnormalizedTypeDefPointer[]
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheConfigSchema

_cacheConfigSchema(project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1069
Cache the schema as represented by graphql-config, with extensions from GraphQLCache.getSchema()

Parameters
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheDocumentFilesforProject

_cacheDocumentFilesforProject(project: GraphQLProjectConfig): Promise<undefined | void[]>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1116
Pre-cache all documents for a project.

TODO: Maybe make this optional, where only schema needs to be pre-cached.

Parameters
- project: GraphQLProjectConfig
Returns Promise<undefined | void[]>

_cacheObjectSchema

_cacheObjectSchema(pointer: {}, project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1008
Parameters
- pointer: {}
  - [key: string]: any
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheSchemaFile

_cacheSchemaFile(_uri: UnnormalizedTypeDefPointer, project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:946
Parameters
- _uri: UnnormalizedTypeDefPointer
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheSchemaFilesForProject

_cacheSchemaFilesForProject(project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1033
Parameters
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheSchemaPath

_cacheSchemaPath(uri: string, project: GraphQLProjectConfig): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:992
Safely attempts to cache schema files based on a glob or path Exits without warning in several cases because these strings can be almost anything!

Parameters
- uri: string
- project: GraphQLProjectConfig
Returns Promise<void>

_cacheSchemaText

_cacheSchemaText(uri: string, text: string, version: number): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:935
Parameters
- uri: string
- text: string
- version: number
Returns Promise<void>

_getCachedDocument

_getCachedDocument(uri: string): CachedDocumentType | null

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1226
Parameters
- uri: string
Returns CachedDocumentType | null

_getTextDocuments

_getTextDocuments(): [string, CachedDocumentType][]

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:931
Returns [string, CachedDocumentType][]

_getTmpProjectPath

_getTmpProjectPath(project: GraphQLProjectConfig, prependWithProtocol?: boolean, appendPath?: undefined | string): string

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:965
Parameters
- project: GraphQLProjectConfig
- Default value prependWithProtocol: boolean = true
- Optional appendPath: undefined | string
Returns string

_handleConfigError

_handleConfigError(__namedParameters: { err: unknown }): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:259
Parameters
- __namedParameters: { err: unknown }
  - err: unknown
Returns void

_invalidateCache

_invalidateCache(textDocument: VersionedTextDocumentIdentifier, uri: Uri, contents: CachedContent[]): Promise<Map<string, CachedDocumentType> | null>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1236
Parameters
- textDocument: VersionedTextDocumentIdentifier
- uri: Uri
- contents: CachedContent[]
Returns Promise<Map<string, CachedDocumentType> | null>

_isGraphQLConfigFile

_isGraphQLConfigFile(uri: string): Promise<boolean>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:298
Parameters
- uri: string
Returns Promise<boolean>

_isRelayCompatMode

_isRelayCompatMode(query: string): boolean

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1166
Parameters
- query: string
Returns boolean

_logConfigError

_logConfigError(errorMessage: string): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:291
Parameters
- errorMessage: string
Returns void

_unwrapProjectSchema

_unwrapProjectSchema(project: GraphQLProjectConfig): string[]

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1196
Parameters
- project: GraphQLProjectConfig
Returns string[]

_updateFragmentDefinition

_updateFragmentDefinition(uri: Uri, contents: CachedContent[]): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1172
Parameters
- uri: Uri
- contents: CachedContent[]
Returns Promise<void>

_updateGraphQLConfig

_updateGraphQLConfig(): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:211
Returns Promise<void>

_updateObjectTypeDefinition

_updateObjectTypeDefinition(uri: Uri, contents: CachedContent[]): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1217
Parameters
- uri: Uri
- contents: CachedContent[]
Returns Promise<void>

_updateSchemaIfChanged

_updateSchemaIfChanged(project: GraphQLProjectConfig, uri: Uri): Promise<void>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:1181
Parameters
- project: GraphQLProjectConfig
- uri: Uri
Returns Promise<void>

handleCompletionRequest

handleCompletionRequest(params: CompletionParams): Promise<CompletionList | Array<CompletionItem>>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:548
Parameters
- params: CompletionParams
Returns Promise<CompletionList | Array<CompletionItem>>

handleDefinitionRequest

handleDefinitionRequest(params: TextDocumentPositionParams, _token?: CancellationToken): Promise<Array<Location>>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:740
Parameters
- params: TextDocumentPositionParams
- Optional _token: CancellationToken
Returns Promise<Array<Location>>

handleDidChangeConfiguration

handleDidChangeConfiguration(_params: DidChangeConfigurationParams): Promise<DidChangeConfigurationRegistrationOptions>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:491
Parameters
- _params: DidChangeConfigurationParams
Returns Promise<DidChangeConfigurationRegistrationOptions>

handleDidChangeNotification

handleDidChangeNotification(params: DidChangeTextDocumentParams): Promise<PublishDiagnosticsParams | null>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:413
Parameters
- params: DidChangeTextDocumentParams
Returns Promise<PublishDiagnosticsParams | null>

handleDidCloseNotification

handleDidCloseNotification(params: DidCloseTextDocumentParams): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:504
Parameters
- params: DidCloseTextDocumentParams
Returns void

handleDidOpenOrSaveNotification

handleDidOpenOrSaveNotification(params: DidSaveTextDocumentParams | DidOpenTextDocumentParams): Promise<PublishDiagnosticsParams | null>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:317
Parameters
- params: DidSaveTextDocumentParams | DidOpenTextDocumentParams
Returns Promise<PublishDiagnosticsParams | null>

handleDocumentSymbolRequest

handleDocumentSymbolRequest(params: DocumentSymbolParams): Promise<Array<SymbolInformation>>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:838
Parameters
- params: DocumentSymbolParams
Returns Promise<Array<SymbolInformation>>

handleExitNotification

handleExitNotification(): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:536
Returns void

handleHoverRequest

handleHoverRequest(params: TextDocumentPositionParams): Promise<Hover>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:606
Parameters
- params: TextDocumentPositionParams
Returns Promise<Hover>

handleInitializeRequest

handleInitializeRequest(params: InitializeParams, _token?: CancellationToken, configDir?: undefined | string): Promise<InitializeResult>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:160
Parameters
- params: InitializeParams
- Optional _token: CancellationToken
- Optional configDir: undefined | string
Returns Promise<InitializeResult>

handleShutdownRequest

handleShutdownRequest(): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:532
Returns void

handleWatchedFilesChangedNotification

handleWatchedFilesChangedNotification(params: DidChangeWatchedFilesParams): Promise<Array<PublishDiagnosticsParams | undefined> | null>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:649
Parameters
- params: DidChangeWatchedFilesParams
Returns Promise<Array<PublishDiagnosticsParams | undefined> | null>

handleWorkspaceSymbolRequest

handleWorkspaceSymbolRequest(params: WorkspaceSymbolParams): Promise<Array<SymbolInformation>>

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:898
Parameters
- params: WorkspaceSymbolParams
Returns Promise<Array<SymbolInformation>>

validateDocumentAndPosition

validateDocumentAndPosition(params: CompletionParams): void

- Defined in packages/graphql-language-service-server/src/MessageProcessor.ts:540
Parameters
- params: CompletionParams
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: undefined | GraphQLConfig

connection: Connection

fileExtensions: ReadonlyArray<".js" | ".cjs" | ".mjs" | ".es" | ".esm" | ".es6" | ".ts" | ".jsx" | ".tsx" | ".vue" | ".svelte" | ".astro" | ".cts" | ".mts">

graphqlFileExtensions: string[]

loadConfigOptions: LoadConfigOptions

logger: Logger | NoopLogger

parser: undefined | parseDocument

tmpDir: undefined | string

Returns MessageProcessor

Properties

_connection

Optional _extensions

_graphQLCache

_graphQLConfig

_isGraphQLConfigMissing

_isInitialized

_languageService

_loadConfigOptions

_logger

_parser

Type declaration

Parameters

text: string

uri: string

Returns CachedContent[]

_rootPath

_schemaCacheInit

_settings

_textDocumentCache

_tmpDir

_tmpDirBase

_tmpUriBase

_willShutdown

Accessors

connection

Returns Connection

Parameters

connection: Connection

Returns void

Methods

_cacheAllProjectFiles

Parameters

config: GraphQLConfig

Returns Promise<undefined | void[]>

_cacheArraySchema

Parameters

pointers: UnnormalizedTypeDefPointer[]

project: GraphQLProjectConfig

Returns Promise<void>

_cacheConfigSchema

Parameters

project: GraphQLProjectConfig

Returns Promise<void>

_cacheDocumentFilesforProject

Parameters

project: GraphQLProjectConfig

Returns Promise<undefined | void[]>

_cacheObjectSchema

Parameters

pointer: {}

[key: string]: any

project: GraphQLProjectConfig

Returns Promise<void>

_cacheSchemaFile

Parameters

_uri: UnnormalizedTypeDefPointer

project: GraphQLProjectConfig

Returns Promise<void>

_cacheSchemaFilesForProject

Parameters

project: GraphQLProjectConfig