Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ServerOptions

Index

Properties

Optional config

pre-existing GraphQLConfig primitive, to override loadConfigOptions and related deprecated fields

Optional configDir

configDir: undefined | string
deprecated

use loadConfigOptions.rootDir now) the directory where graphql-config is found

Optional debug

debug: undefined | true

debug mode

same as with the client reference implementation, the debug setting controls logging output this allows all logger.info() messages to come through. by default, the highest level is warn

Optional encoding

encoding: "utf-8" | "ascii"

(socket only) encoding for the LSP server to use.

default

'utf-8'

Optional extensions

deprecated

use loadConfigOptions.extensions

Optional fileExtensions

fileExtensions: ReadonlyArray<SupportedExtensionsEnum>

allowed file extensions for embedded graphql, used by the parser. note that with vscode, this is also controlled by manifest and client configurations. do not put full-file graphql extensions here!

default

['.js', '.jsx', '.tsx', '.ts', '.mjs']

Optional graphqlFileExtensions

graphqlFileExtensions: string[]

allowed file extensions for full-file graphql, used by the parser.

default

['graphql', 'graphqls', 'gql' ]

Optional hostname

hostname: undefined | string

(socket only) hostname for the LSP server to run on.

default

'127.0.0.1'

Optional loadConfigOptions

loadConfigOptions: LoadConfigOptions

LoadConfigOptions from graphql-config@3 to use when we loadConfig() uses process.cwd() by default for rootDir option. you can also pass explicit filepath, add extensions, etc

Optional method

method: "socket" | "stream" | "node"

socket, streams, or node (ipc).

default

'node'

Optional parser

parser: typeof parseDocument

custom, multi-language parser used by the LSP server. detects extension from uri and decides how to parse it. uses graphql.parse() by default response format is designed to assist with developing LSP tooling around embedded language support

Optional port

port: undefined | number

(socket only) port for the LSP server to run on. required if using method socket

Optional tmpDir

tmpDir: undefined | string

the temporary directory that the server writes to for logs and caching schema

Generated using TypeDoc