GraphQL Config

GraphQL Config config file

Type IGraphQLProjects | IGraphQLProject | IGraphQLProjectLegacy
File match graphql.config.json graphql.config.yaml graphql.config.yml .graphqlrc .graphqlrc.json .graphqlrc.yaml .graphqlrc.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/graphql-config/latest.json
Source https://unpkg.com/graphql-config/config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: IGraphQLProjects | IGraphQLProject | IGraphQLProjectLegacy

Structure of GraphQL Config

Any of

1. IGraphQLProjects object
2. IGraphQLProject object
3. IGraphQLProjectLegacy object

Definitions

DocumentPointer string[] | string
IExtensions Record<string, any>

Configuration of each used extension

IGraphQLProject object

GraphQL Project

schema object | object | string[] | string required
documents string[] | string
exclude WithList%3Cstring%3E
extensions Record<string, any>

Configuration of each used extension

include WithList%3Cstring%3E
IGraphQLProjectLegacy object

Legacy structure of GraphQL Config v2

schemaPath string required
excludes string[]
extensions Record<string, any>

Configuration of each used extension

includes string[]
IGraphQLProjects object

Multiple named projects

projects Record<string, IGraphQLProject | IGraphQLProjectLegacy> required
SchemaPointer object | object | string[] | string
WithList<string> string[] | string