• Docs
  • API Reference
  • Interfaces
  • GraphQLSchemaWithContext

Interface: GraphQLSchemaWithContext<TContext>

schema/src.GraphQLSchemaWithContext

Type parameters

Name
TContext

Hierarchy

  • GraphQLSchema

    GraphQLSchemaWithContext

Table of contents

Properties

Accessors

Methods

Properties

__context

Optional __context: TContext

Defined in

packages/schema/src/types.ts:11


__validationErrors

__validationErrors: Maybe<readonly GraphQLError[]>

Inherited from

GraphQLSchema.__validationErrors

Defined in

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


astNode

astNode: Maybe<SchemaDefinitionNode>

Inherited from

GraphQLSchema.astNode

Defined in

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


description

description: Maybe<string>

Inherited from

GraphQLSchema.description

Defined in

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


extensionASTNodes

extensionASTNodes: readonly SchemaExtensionNode[]

Inherited from

GraphQLSchema.extensionASTNodes

Defined in

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


extensions

extensions: Readonly<GraphQLSchemaExtensions>

Inherited from

GraphQLSchema.extensions

Defined in

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

Accessors

[toStringTag]

get [toStringTag](): string

Returns

string

Inherited from

GraphQLSchema.__@toStringTag@2094

Defined in

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

Methods

getDirective

getDirective(name): Maybe<GraphQLDirective>

Parameters

NameType
namestring

Returns

Maybe<GraphQLDirective>

Inherited from

GraphQLSchema.getDirective

Defined in

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


getDirectives

getDirectives(): readonly GraphQLDirective[]

Returns

readonly GraphQLDirective[]

Inherited from

GraphQLSchema.getDirectives

Defined in

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


getImplementations

getImplementations(interfaceType): Object

Parameters

NameType
interfaceTypeGraphQLInterfaceType

Returns

Object

NameType
interfacesreadonly GraphQLInterfaceType[]
objectsreadonly GraphQLObjectType<any, any>[]

Inherited from

GraphQLSchema.getImplementations

Defined in

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


getMutationType

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

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getMutationType

Defined in

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


getPossibleTypes

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

Parameters

NameType
abstractTypeGraphQLAbstractType

Returns

readonly GraphQLObjectType<any, any>[]

Inherited from

GraphQLSchema.getPossibleTypes

Defined in

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


getQueryType

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

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getQueryType

Defined in

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


getRootType

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

Parameters

NameType
operationOperationTypeNode

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getRootType

Defined in

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


getSubscriptionType

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

Returns

Maybe<GraphQLObjectType<any, any>>

Inherited from

GraphQLSchema.getSubscriptionType

Defined in

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


getType

getType(name): undefined | GraphQLNamedType

Parameters

NameType
namestring

Returns

undefined | GraphQLNamedType

Inherited from

GraphQLSchema.getType

Defined in

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


getTypeMap

getTypeMap(): TypeMap

Returns

TypeMap

Inherited from

GraphQLSchema.getTypeMap

Defined in

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


isSubType

isSubType(abstractType, maybeSubType): boolean

Parameters

NameType
abstractTypeGraphQLAbstractType
maybeSubTypeGraphQLInterfaceType | GraphQLObjectType<any, any>

Returns

boolean

Inherited from

GraphQLSchema.isSubType

Defined in

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


toConfig

toConfig(): GraphQLSchemaNormalizedConfig

Returns

GraphQLSchemaNormalizedConfig

Inherited from

GraphQLSchema.toConfig

Defined in

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