schema_src.iexecutableschemadefinition

Interface: IExecutableSchemaDefinition<TContext\>#

schema/src.IExecutableSchemaDefinition

Configuration object for creating an executable schema

Type parameters#

NameDefault
TContextany

Hierarchy#

  • IExecutableSchemaDefinition

Table of contents#

Properties#

Properties#

allowUndefinedInResolve#

Optional allowUndefinedInResolve: boolean

Set to false to have resolvers throw an if they return undefined, which can help make debugging easier

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


directiveResolvers#

Optional directiveResolvers: IDirectiveResolvers<any, TContext\>

Map of directive resolvers

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


inheritResolversFromInterfaces#

Optional inheritResolversFromInterfaces: boolean

GraphQL object types that implement interfaces will inherit any missing resolvers from their interface types defined in the resolvers object

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


logger#

Optional logger: ILogger

Logger instance used to print errors to the server console that are usually swallowed by GraphQL.

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


noExtensionExtraction#

Optional noExtensionExtraction: boolean

Do not extract and apply extensions seperately and leave it to buildASTSchema

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


parseOptions#

Optional parseOptions: GraphQLParseOptions

Additional options for parsing the type definitions if they are provided as a string

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


pruningOptions#

Optional pruningOptions: PruneSchemaOptions

Additional options for removing unused types from the schema

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


resolverValidationOptions#

Optional resolverValidationOptions: IResolverValidationOptions

Additional options for validating the provided resolvers

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


resolvers#

Optional resolvers: Record<string, IUnionTypeResolver | IScalarTypeResolver | IEnumTypeResolver | IInputObjectTypeResolver | IFieldResolver<any, TContext, Record<string, any\>, any\> | IObjectTypeResolver<any, TContext, any\> | IInterfaceTypeResolver<any, TContext, any\>\> | Record<string, IUnionTypeResolver | IScalarTypeResolver | IEnumTypeResolver | IInputObjectTypeResolver | IFieldResolver<any, TContext, Record<string, any\>, any\> | IObjectTypeResolver<any, TContext, any\> | IInterfaceTypeResolver<any, TContext, any\>\>[]

Object describing the field resolvers for the provided type definitions

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


schemaDirectives#

Optional schemaDirectives: Record<string, typeof SchemaDirectiveVisitor\>

A map of schema directives used with the legacy class-based implementation of schema directives

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


schemaTransforms#

Optional schemaTransforms: ExecutableSchemaTransformation[]

An array of schema transformation functions

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


typeDefs#

typeDefs: ITypeDefinitions

The type definitions used to create the schema

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


updateResolversInPlace#

Optional updateResolversInPlace: boolean

Do not create a schema again and use the one from buildASTSchema

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