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 extensions

(deprecated: use loadConfigOptions.extensions now) array of functions to transform the graphql-config and add extensions dynamically

Optional fileExtensions

fileExtensions: ReadonlyArray<SupportedExtensionsEnum>

default: ['.js', '.jsx', '.tsx', '.ts', '.mjs'] 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!

Optional graphqlFileExtensions

graphqlFileExtensions: string[]

default: ['graphql'] - allowed file extensions for graphql, used by the parser

Optional hostname

hostname: undefined | string

hostname if using socker

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). node by default.

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

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