Class GraphQLCache

constructor

• new GraphQLCache(
      __namedParameters: {
          config: GraphQLConfig;
          configDir: string;
          logger: Logger | NoopLogger;
          onSchemaChange?: OnSchemaChange;
          parser: (
              text: string,
              uri: string,
              fileExtensions?: readonly (
                  | ".js"
                  | ".cjs"
                  | ".mjs"
                  | ".es"
                  | ".esm"
                  | ".es6"
                  | ".ts"
                  | ".jsx"
                  | ".tsx"
                  | ".vue"
                  | ".svelte"
                  | ".astro"
                  | ".cts"
                  | ".mts"
              )[],
              graphQLFileExtensions?: string[],
              logger?: Logger | NoopLogger,
          ) => Promise<CachedContent[]>;
          schemaCacheTTL?: number;
      },
  ): GraphQLCache

  Parameters

  • __namedParameters: {
        config: GraphQLConfig;
        configDir: string;
        logger: Logger | NoopLogger;
        onSchemaChange?: OnSchemaChange;
        parser: (
            text: string,
            uri: string,
            fileExtensions?: readonly (
                | ".js"
                | ".cjs"
                | ".mjs"
                | ".es"
                | ".esm"
                | ".es6"
                | ".ts"
                | ".jsx"
                | ".tsx"
                | ".vue"
                | ".svelte"
                | ".astro"
                | ".cts"
                | ".mts"
            )[],
            graphQLFileExtensions?: string[],
            logger?: Logger | NoopLogger,
        ) => Promise<CachedContent[]>;
        schemaCacheTTL?: number;
    }

    • config: GraphQLConfig

    • configDir: string

    • logger: Logger | NoopLogger

    • OptionalonSchemaChange?: OnSchemaChange

    • parser: (
          text: string,
          uri: string,
          fileExtensions?: readonly (
              | ".js"
              | ".cjs"
              | ".mjs"
              | ".es"
              | ".esm"
              | ".es6"
              | ".ts"
              | ".jsx"
              | ".tsx"
              | ".vue"
              | ".svelte"
              | ".astro"
              | ".cts"
              | ".mts"
          )[],
          graphQLFileExtensions?: string[],
          logger?: Logger | NoopLogger,
      ) => Promise<CachedContent[]>

    • OptionalschemaCacheTTL?: number

  Returns GraphQLCache

_configDir

_fragmentDefinitionsCache

_graphQLConfig

_graphQLFileListCache

_logger

Optional_onSchemaChange

_parser

Optional_schemaCacheTTL

_schemaMap

_typeDefinitionsCache

_typeExtensionMap

_cacheKeyForProject

• _cacheKeyForProject(__namedParameters: GraphQLProjectConfig): string

  Parameters

  • __namedParameters: GraphQLProjectConfig

  Returns string

_extendSchema

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

  Parameters

  • schema: GraphQLSchema
  • schemaPath: string | null
  • schemaCacheKey: string | null

  Returns GraphQLSchema

_getProjectName

• _getProjectName(projectConfig: GraphQLProjectConfig): string

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns string

_getSchemaAndDocumentFilePatterns

• _getSchemaAndDocumentFilePatterns(projectConfig: GraphQLProjectConfig): string[]

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns string[]

_getSchemaCacheKeyForProject

• _getSchemaCacheKeyForProject(
      projectConfig: GraphQLProjectConfig,
  ): UnnormalizedTypeDefPointer

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns UnnormalizedTypeDefPointer

_readFilesFromInputDirs

• _readFilesFromInputDirs(
      rootDir: string,
      projectConfig: GraphQLProjectConfig,
  ): Promise<GraphQLFileMetadata[]>

  Parameters

  • rootDir: string
  • projectConfig: GraphQLProjectConfig

  Returns Promise<GraphQLFileMetadata[]>

_setDefinitionCache

• _setDefinitionCache(
      asts: { ast: DocumentNode | null; query: string }[],
      typeCache: Map<string, ObjectTypeInfo>,
      filePath: string | undefined,
  ): Map<string, ObjectTypeInfo>

  Parameters

  • asts: { ast: DocumentNode | null; query: string }[]
  • typeCache: Map<string, ObjectTypeInfo>
  • filePath: string | undefined

  Returns Map<string, ObjectTypeInfo>

_setFragmentCache

• _setFragmentCache(
      asts: { ast: DocumentNode | null; query: string }[],
      fragmentCache: Map<string, FragmentInfo>,
      filePath: string | undefined,
  ): Map<string, FragmentInfo>

  Parameters

  • asts: { ast: DocumentNode | null; query: string }[]
  • fragmentCache: Map<string, FragmentInfo>
  • filePath: string | undefined

  Returns Map<string, FragmentInfo>

getFragmentDefinitions

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

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns Promise<Map<string, FragmentInfo>>

getFragmentDependencies

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

  Parameters

  • query: string
  • OptionalfragmentDefinitions: Map<string, FragmentInfo> | null

  Returns Promise<FragmentInfo[]>

getFragmentDependenciesForAST

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

  Parameters

  • parsedQuery: ASTNode
  • fragmentDefinitions: Map<string, FragmentInfo>

  Returns Promise<FragmentInfo[]>

getGraphQLConfig

• getGraphQLConfig(): GraphQLConfig

  Returns GraphQLConfig

getObjectTypeDefinitions

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

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns Promise<Map<string, ObjectTypeInfo>>

getObjectTypeDependenciesForAST

• getObjectTypeDependenciesForAST(
      parsedQuery: ASTNode,
      objectTypeDefinitions: Map<string, ObjectTypeInfo>,
  ): Promise<ObjectTypeInfo[]>

  Parameters

  • parsedQuery: ASTNode
  • objectTypeDefinitions: Map<string, ObjectTypeInfo>

  Returns Promise<ObjectTypeInfo[]>

getProjectForFile

• getProjectForFile(uri: string): void | GraphQLProjectConfig

  Parameters

  • uri: string

  Returns void | GraphQLProjectConfig

getSchema

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

  Parameters

  • OptionalappName: string
  • OptionalqueryHasExtensions: boolean | null

  Returns Promise<GraphQLSchema | null>

invalidateSchemaCacheForProject

• invalidateSchemaCacheForProject(projectConfig: GraphQLProjectConfig): void

  Parameters

  • projectConfig: GraphQLProjectConfig

  Returns void

processGraphQLFiles

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

  Takes an array of GraphQL File information and batch-processes into a map of fragmentDefinitions and GraphQL file cache.

  Parameters

  • responses: GraphQLFileInfo[]

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

promiseToReadGraphQLFile

• promiseToReadGraphQLFile(filePath: string): Promise<GraphQLFileInfo>

  Returns a Promise to read a GraphQL file and return a GraphQL metadata including a parsed AST.

  Parameters

  • filePath: string

  Returns Promise<GraphQLFileInfo>

readAllGraphQLFiles

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

  Given a list of GraphQL file metadata, read all files collected from watchman and create fragmentDefinitions and GraphQL files cache.

  Parameters

  • list: GraphQLFileMetadata[]

  Returns Promise<
      {
          fragmentDefinitions: Map<string, FragmentInfo>;
          graphQLFileMap: Map<string, GraphQLFileInfo>;
          objectTypeDefinitions: Map<string, ObjectTypeInfo>;
      },
  >

updateFragmentDefinition

• updateFragmentDefinition(
      projectCacheKey: string,
      filePath: string,
      contents: CachedContent[],
  ): Promise<void>

  Parameters

  • projectCacheKey: string
  • filePath: string
  • contents: CachedContent[]

  Returns Promise<void>

updateObjectTypeDefinition

• updateObjectTypeDefinition(
      projectCacheKey: string,
      filePath: string,
      contents: CachedContent[],
  ): Promise<void>

  Parameters

  • projectCacheKey: string
  • filePath: string
  • contents: CachedContent[]

  Returns Promise<void>