GraphQLCache | GraphQL Official LSP Documentation

Hierarchy

GraphQLCache

Implements

GraphQLCache

Index

Constructors

constructor

Properties

Constructors

constructor

new GraphQLCache(__namedParameters: { config: GraphQLConfig; configDir: string; logger: Logger | NoopLogger; parser: parseDocument }): GraphQLCache

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:105
Parameters
- __namedParameters: { config: GraphQLConfig; configDir: string; logger: Logger | NoopLogger; parser: parseDocument }
  - config: GraphQLConfig
  - configDir: string
  - logger: Logger | NoopLogger
  - parser: parseDocument
Returns GraphQLCache

Properties

_configDir

_configDir: Uri

_fragmentDefinitionsCache

_fragmentDefinitionsCache: Map<Uri, Map<string, FragmentInfo>>

_graphQLConfig

_graphQLConfig: GraphQLConfig

_graphQLFileListCache

_graphQLFileListCache: Map<Uri, Map<string, GraphQLFileInfo>>

_logger

_logger: Logger | NoopLogger

_parser

_parser: typeof parseDocument

_schemaMap

_schemaMap: Map<Uri, GraphQLSchema>

_typeDefinitionsCache

_typeDefinitionsCache: Map<Uri, Map<string, ObjectTypeInfo>>

_typeExtensionMap

_typeExtensionMap: Map<Uri, number>

Methods

_cacheKeyForProject

_cacheKeyForProject(__namedParameters: { dirpath: string; name: string }): string

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:213
Parameters
- __namedParameters: { dirpath: string; name: string }
  - dirpath: string
  - name: string
Returns string

_extendSchema

_extendSchema(schema: GraphQLSchema, schemaPath: string | null, schemaCacheKey: string | null): GraphQLSchema

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:585
Parameters
- schema: GraphQLSchema
- schemaPath: string | null
- schemaCacheKey: string | null
Returns GraphQLSchema

_getProjectName

_getProjectName(projectConfig: GraphQLProjectConfig): GraphQLProjectConfig

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:715
Parameters
- projectConfig: GraphQLProjectConfig
Returns GraphQLProjectConfig

_getSchemaAndDocumentFilePatterns

_getSchemaAndDocumentFilePatterns(projectConfig: GraphQLProjectConfig): string[]

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:411
Parameters
- projectConfig: GraphQLProjectConfig
Returns string[]

_getSchemaCacheKeyForProject

_getSchemaCacheKeyForProject(projectConfig: GraphQLProjectConfig): UnnormalizedTypeDefPointer

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:709
Parameters
- projectConfig: GraphQLProjectConfig
Returns UnnormalizedTypeDefPointer

_readFilesFromInputDirs

_readFilesFromInputDirs(rootDir: string, projectConfig: GraphQLProjectConfig): Promise<Array<GraphQLFileMetadata>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:347
Parameters
- rootDir: string
- projectConfig: GraphQLProjectConfig
Returns Promise<Array<GraphQLFileMetadata>>

_updateGraphQLFileListCache

_updateGraphQLFileListCache(graphQLFileMap: Map<Uri, GraphQLFileInfo>, metrics: { mtime: number; size: number }, filePath: Uri, exists: boolean): Promise<Map<Uri, GraphQLFileInfo>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:427
Parameters
- graphQLFileMap: Map<Uri, GraphQLFileInfo>
- metrics: { mtime: number; size: number }
  - mtime: number
  - size: number
- filePath: Uri
- exists: boolean
Returns Promise<Map<Uri, GraphQLFileInfo>>

getFragmentDefinitions

getFragmentDefinitions(projectConfig: GraphQLProjectConfig): Promise<Map<string, FragmentInfo>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:217
Parameters
- projectConfig: GraphQLProjectConfig
Returns Promise<Map<string, FragmentInfo>>

getFragmentDependencies

getFragmentDependencies(query: string, fragmentDefinitions?: Map<string, FragmentInfo> | null): Promise<FragmentInfo[]>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:142
Parameters
- query: string
- Optional fragmentDefinitions: Map<string, FragmentInfo> | null
Returns Promise<FragmentInfo[]>

getFragmentDependenciesForAST

getFragmentDependenciesForAST(parsedQuery: ASTNode, fragmentDefinitions: Map<string, FragmentInfo>): Promise<FragmentInfo[]>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:162
Parameters
- parsedQuery: ASTNode
- fragmentDefinitions: Map<string, FragmentInfo>
Returns Promise<FragmentInfo[]>

getGraphQLConfig

getGraphQLConfig(): GraphQLConfig

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:129
Returns GraphQLConfig

getObjectTypeDefinitions

getObjectTypeDefinitions(projectConfig: GraphQLProjectConfig): Promise<Map<string, ObjectTypeInfo>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:328
Parameters
- projectConfig: GraphQLProjectConfig
Returns Promise<Map<string, ObjectTypeInfo>>

getObjectTypeDependencies

getObjectTypeDependencies(query: string, objectTypeDefinitions?: Map<string, ObjectTypeInfo>): Promise<Array<ObjectTypeInfo>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:239
Parameters
- query: string
- Optional objectTypeDefinitions: Map<string, ObjectTypeInfo>
Returns Promise<Array<ObjectTypeInfo>>

getObjectTypeDependenciesForAST

getObjectTypeDependenciesForAST(parsedQuery: ASTNode, objectTypeDefinitions: Map<string, ObjectTypeInfo>): Promise<Array<ObjectTypeInfo>>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:262
Parameters
- parsedQuery: ASTNode
- objectTypeDefinitions: Map<string, ObjectTypeInfo>
Returns Promise<Array<ObjectTypeInfo>>

getProjectForFile

getProjectForFile(uri: string): GraphQLProjectConfig | void

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:131
Parameters
- uri: string
Returns GraphQLProjectConfig | void

getSchema

getSchema(appName?: undefined | string, queryHasExtensions?: boolean | null): Promise<GraphQLSchema | null>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:647
Parameters
- Optional appName: undefined | string
- Optional queryHasExtensions: boolean | null
Returns Promise<GraphQLSchema | null>

invalidateSchemaCacheForProject

invalidateSchemaCacheForProject(projectConfig: GraphQLProjectConfig): void

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:700
Parameters
- projectConfig: GraphQLProjectConfig
Returns void

processGraphQLFiles

processGraphQLFiles(responses: Array<GraphQLFileInfo>): { fragmentDefinitions: Map<string, FragmentInfo>; graphQLFileMap: Map<string, GraphQLFileInfo>; objectTypeDefinitions: Map<string, ObjectTypeInfo> }

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:770
Takes an array of GraphQL File information and batch-processes into a map of fragmentDefinitions and GraphQL file cache.

Parameters
- responses: Array<GraphQLFileInfo>
Returns { fragmentDefinitions: Map<string, FragmentInfo>; graphQLFileMap: Map<string, GraphQLFileInfo>; objectTypeDefinitions: Map<string, ObjectTypeInfo> }
- fragmentDefinitions: Map<string, FragmentInfo>
- graphQLFileMap: Map<string, GraphQLFileInfo>
- objectTypeDefinitions: Map<string, ObjectTypeInfo>

promiseToReadGraphQLFile

promiseToReadGraphQLFile(filePath: Uri): Promise<GraphQLFileInfo>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:825
Returns a Promise to read a GraphQL file and return a GraphQL metadata including a parsed AST.

Parameters
- filePath: Uri
Returns Promise<GraphQLFileInfo>

readAllGraphQLFiles

readAllGraphQLFiles(list: Array<GraphQLFileMetadata>): Promise<{ fragmentDefinitions: Map<string, FragmentInfo>; graphQLFileMap: Map<string, GraphQLFileInfo>; objectTypeDefinitions: Map<string, ObjectTypeInfo> }>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:723
Given a list of GraphQL file metadata, read all files collected from watchman and create fragmentDefinitions and GraphQL files cache.

Parameters
- list: Array<GraphQLFileMetadata>
Returns Promise<{ fragmentDefinitions: Map<string, FragmentInfo>; graphQLFileMap: Map<string, GraphQLFileInfo>; objectTypeDefinitions: Map<string, ObjectTypeInfo> }>

updateFragmentDefinition

updateFragmentDefinition(rootDir: Uri, filePath: Uri, contents: Array<CachedContent>): Promise<void>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:453
Parameters
- rootDir: Uri
- filePath: Uri
- contents: Array<CachedContent>
Returns Promise<void>

updateFragmentDefinitionCache

updateFragmentDefinitionCache(rootDir: Uri, filePath: Uri, exists: boolean): Promise<void>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:493
Parameters
- rootDir: Uri
- filePath: Uri
- exists: boolean
Returns Promise<void>

updateObjectTypeDefinition

updateObjectTypeDefinition(rootDir: Uri, filePath: Uri, contents: Array<CachedContent>): Promise<void>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:519
Parameters
- rootDir: Uri
- filePath: Uri
- contents: Array<CachedContent>
Returns Promise<void>

updateObjectTypeDefinitionCache

updateObjectTypeDefinitionCache(rootDir: Uri, filePath: Uri, exists: boolean): Promise<void>

- Defined in packages/graphql-language-service-server/src/GraphQLCache.ts:559
Parameters
- rootDir: Uri
- filePath: Uri
- exists: boolean
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { config: GraphQLConfig; configDir: string; logger: Logger | NoopLogger; parser: parseDocument }

config: GraphQLConfig

configDir: string

logger: Logger | NoopLogger

parser: parseDocument

Returns GraphQLCache

Properties

_configDir

_fragmentDefinitionsCache

_graphQLConfig

_graphQLFileListCache

_logger

_parser

_schemaMap

_typeDefinitionsCache

_typeExtensionMap

Methods

_cacheKeyForProject

Parameters

__namedParameters: { dirpath: string; name: string }

dirpath: string

name: string

Returns string

_extendSchema

Parameters

schema: GraphQLSchema

schemaPath: string | null

schemaCacheKey: string | null

Returns GraphQLSchema

_getProjectName

Parameters

projectConfig: GraphQLProjectConfig

Returns GraphQLProjectConfig

_getSchemaAndDocumentFilePatterns

Parameters

projectConfig: GraphQLProjectConfig

Returns string[]

_getSchemaCacheKeyForProject

Parameters

projectConfig: GraphQLProjectConfig

Returns UnnormalizedTypeDefPointer

_readFilesFromInputDirs

Parameters

rootDir: string

projectConfig: GraphQLProjectConfig

Returns Promise<Array<GraphQLFileMetadata>>

_updateGraphQLFileListCache

Parameters

graphQLFileMap: Map<Uri, GraphQLFileInfo>

metrics: { mtime: number; size: number }

mtime: number

size: number

filePath: Uri

exists: boolean

Returns Promise<Map<Uri, GraphQLFileInfo>>

getFragmentDefinitions

Parameters

projectConfig: GraphQLProjectConfig

Returns Promise<Map<string, FragmentInfo>>

getFragmentDependencies

Parameters

query: string

Optional fragmentDefinitions: Map<string, FragmentInfo> | null

Returns Promise<FragmentInfo[]>

getFragmentDependenciesForAST

Parameters

parsedQuery: ASTNode

fragmentDefinitions: Map<string, FragmentInfo>

Returns Promise<FragmentInfo[]>

getGraphQLConfig

Returns GraphQLConfig