GraphQLSchema

Create and operate on GraphQL type definitions and schema.

Index

Constructors

• constructor

Properties

• __validationErrors
• astNode
• description
• extensionASTNodes
• extensions

Accessors

• [toStringTag]

Methods

• getDirective
• getDirectives
• getImplementations
• getMutationType
• getPossibleTypes
• getQueryType
• getRootType
• getSubscriptionType
• getType
• getTypeMap
• isSubType
• toConfig

Constructors

constructor

• new GraphQLSchema(config: Readonly<GraphQLSchemaConfig>): GraphQLSchema

• Parameters

  • config: Readonly<GraphQLSchemaConfig>

  Returns GraphQLSchema

Properties

__validationErrors

__validationErrors: Maybe<readonly GraphQLError[]>

astNode

astNode: Maybe<SchemaDefinitionNode>

description

description: Maybe<string>

extensionASTNodes

extensionASTNodes: readonly SchemaExtensionNode[]

extensions

extensions: Readonly<GraphQLSchemaExtensions>

Accessors

[toStringTag]

• get [toStringTag](): string

• Returns string

Methods

getDirective

• getDirective(name: string): Maybe<GraphQLDirective>

• Parameters

  • name: string

  Returns Maybe<GraphQLDirective>

getDirectives

• getDirectives(): readonly GraphQLDirective[]

• Returns readonly GraphQLDirective[]

getImplementations

• getImplementations(interfaceType: GraphQLInterfaceType): { interfaces?: readonly GraphQLInterfaceType[]; objects?: readonly GraphQLObjectType<any, any>[] }

• Parameters

  • interfaceType: GraphQLInterfaceType

  Returns { interfaces?: readonly GraphQLInterfaceType[]; objects?: readonly GraphQLObjectType<any, any>[] }

  • interfaces: readonly GraphQLInterfaceType[]

  • objects: readonly GraphQLObjectType<any, any>[]

getMutationType

• getMutationType(): Maybe<GraphQLObjectType<any, any>>

• Returns Maybe<GraphQLObjectType<any, any>>

getPossibleTypes

• getPossibleTypes(abstractType: GraphQLAbstractType): readonly GraphQLObjectType<any, any>[]

• Parameters

  • abstractType: GraphQLAbstractType

  Returns readonly GraphQLObjectType<any, any>[]

getQueryType

• getQueryType(): Maybe<GraphQLObjectType<any, any>>

• Returns Maybe<GraphQLObjectType<any, any>>

getRootType

• getRootType(operation: OperationTypeNode): Maybe<GraphQLObjectType<any, any>>

• Parameters

  • operation: OperationTypeNode

  Returns Maybe<GraphQLObjectType<any, any>>

getSubscriptionType

• getSubscriptionType(): Maybe<GraphQLObjectType<any, any>>

• Returns Maybe<GraphQLObjectType<any, any>>

getType

• getType(name: string): undefined | GraphQLNamedType

• Parameters

  • name: string

  Returns undefined | GraphQLNamedType

getTypeMap

• getTypeMap(): TypeMap

• Returns TypeMap

isSubType

• isSubType(abstractType: GraphQLAbstractType, maybeSubType: GraphQLObjectType<any, any> | GraphQLInterfaceType): boolean

• Parameters

  • abstractType: GraphQLAbstractType

  • maybeSubType: GraphQLObjectType<any, any> | GraphQLInterfaceType

  Returns boolean

toConfig

• toConfig(): GraphQLSchemaNormalizedConfig

• Returns GraphQLSchemaNormalizedConfig