Skip to Content
GraphQL Tools
DocumentationAPI@graphql-tools/schemasrcinterfacesGraphQLSchemaWithContext

Interface: GraphQLSchemaWithContext<TContext>

Defined in: packages/schema/src/types.ts:10

Extends

  • GraphQLSchema

Type Parameters

TContext

TContext

Properties

__context?

optional __context?: TContext

Defined in: packages/schema/src/types.ts:11


__validationErrors

__validationErrors: Maybe<readonly GraphQLError[]>

Defined in: node_modules/graphql/type/schema.d.ts:106

Inherited from

GraphQLSchema.__validationErrors


astNode

astNode: Maybe<SchemaDefinitionNode>

Defined in: node_modules/graphql/type/schema.d.ts:104

Inherited from

GraphQLSchema.astNode


description

description: Maybe<string>

Defined in: node_modules/graphql/type/schema.d.ts:102

Inherited from

GraphQLSchema.description


extensionASTNodes

extensionASTNodes: readonly SchemaExtensionNode[]

Defined in: node_modules/graphql/type/schema.d.ts:105

Inherited from

GraphQLSchema.extensionASTNodes


extensions

extensions: Readonly<GraphQLSchemaExtensions>

Defined in: node_modules/graphql/type/schema.d.ts:103

Inherited from

GraphQLSchema.extensions

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: node_modules/graphql/type/schema.d.ts:115

Returns

string

Inherited from

GraphQLSchema.[toStringTag]

Methods

getDirective()

getDirective(name): Maybe<GraphQLDirective>

Defined in: node_modules/graphql/type/schema.d.ts:134

Parameters

name

string

Returns

Maybe<GraphQLDirective>

Inherited from

GraphQLSchema.getDirective


getDirectives()

getDirectives(): readonly GraphQLDirective[]

Defined in: node_modules/graphql/type/schema.d.ts:133

Returns

readonly GraphQLDirective[]

Inherited from

GraphQLSchema.getDirectives


getImplementations()

getImplementations(interfaceType): object

Defined in: node_modules/graphql/type/schema.d.ts:125

Parameters

interfaceType

GraphQLInterfaceType

Returns

object

interfaces

interfaces: readonly GraphQLInterfaceType[]

objects

objects: readonly GraphQLObjectType<any, any>[]

Inherited from

GraphQLSchema.getImplementations


getMutationType()

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

Defined in: node_modules/graphql/type/schema.d.ts:117

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getMutationType


getPossibleTypes()

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

Defined in: node_modules/graphql/type/schema.d.ts:122

Parameters

abstractType

GraphQLAbstractType

Returns

readonly GraphQLObjectType<any, any>[]

Inherited from

GraphQLSchema.getPossibleTypes


getQueryType()

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

Defined in: node_modules/graphql/type/schema.d.ts:116

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getQueryType


getRootType()

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

Defined in: node_modules/graphql/type/schema.d.ts:119

Parameters

operation

OperationTypeNode

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getRootType


getSubscriptionType()

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

Defined in: node_modules/graphql/type/schema.d.ts:118

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getSubscriptionType


getType()

getType(name): GraphQLNamedType | undefined

Defined in: node_modules/graphql/type/schema.d.ts:121

Parameters

name

string

Returns

GraphQLNamedType | undefined

Inherited from

GraphQLSchema.getType


getTypeMap()

getTypeMap(): TypeMap

Defined in: node_modules/graphql/type/schema.d.ts:120

Returns

TypeMap

Inherited from

GraphQLSchema.getTypeMap


isSubType()

isSubType(abstractType, maybeSubType): boolean

Defined in: node_modules/graphql/type/schema.d.ts:129

Parameters

abstractType

GraphQLAbstractType

maybeSubType

GraphQLObjectType<any, any> | GraphQLInterfaceType

Returns

boolean

Inherited from

GraphQLSchema.isSubType


toConfig()

toConfig(): GraphQLSchemaNormalizedConfig

Defined in: node_modules/graphql/type/schema.d.ts:135

Returns

GraphQLSchemaNormalizedConfig

Inherited from

GraphQLSchema.toConfig