Docs
API Reference
Interfaces
IExecutableSchemaDefinition

Interface: IExecutableSchemaDefinition<TContext>

schema/src.IExecutableSchemaDefinition

Configuration object for creating an executable schema

Type parameters

NameType
TContextany

Hierarchy

Table of contents

Properties

Properties

allowLegacySDLEmptyFields

Optional allowLegacySDLEmptyFields: boolean

Inherited from

GraphQLParseOptions.allowLegacySDLEmptyFields

Defined in

packages/utils/src/Interfaces.ts:93 (opens in a new tab)


allowLegacySDLImplementsInterfaces

Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

GraphQLParseOptions.allowLegacySDLImplementsInterfaces

Defined in

packages/utils/src/Interfaces.ts:94 (opens in a new tab)


assumeValid

Optional assumeValid: boolean

When building a schema from a GraphQL service's introspection result, it might be safe to assume the schema is valid. Set to true to assume the produced schema is valid.

Default: false

Inherited from

BuildSchemaOptions.assumeValid

Defined in

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


assumeValidSDL

Optional assumeValidSDL: boolean

Set to true to assume the SDL is valid.

Default: false

Inherited from

BuildSchemaOptions.assumeValidSDL

Defined in

node_modules/graphql/utilities/buildASTSchema.d.ts:12


commentDescriptions

Optional commentDescriptions: boolean

Set to true in order to convert all GraphQL comments (marked with # sign) to descriptions (""") GraphQL has built-in support for transforming descriptions to comments (with print), but not while parsing. Turning the flag on will support the other way as well (parse)

Inherited from

GraphQLParseOptions.commentDescriptions

Defined in

packages/utils/src/Interfaces.ts:101 (opens in a new tab)


experimentalFragmentVariables

Optional experimentalFragmentVariables: boolean

Inherited from

GraphQLParseOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:95 (opens in a new tab)


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:34 (opens in a new tab)


noLocation

Optional noLocation: boolean

Inherited from

GraphQLParseOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:92 (opens in a new tab)


resolverValidationOptions

Optional resolverValidationOptions: IResolverValidationOptions

Additional options for validating the provided resolvers

Defined in

packages/schema/src/types.ts:29 (opens in a new tab)


resolvers

Optional resolvers: IResolvers<any, TContext, Record<string, any>, any> | IResolvers<any, TContext, Record<string, any>, any>[]

Object describing the field resolvers for the provided type definitions

Defined in

packages/schema/src/types.ts:25 (opens in a new tab)


schemaExtensions

Optional schemaExtensions: SchemaExtensions | SchemaExtensions[]

Schema extensions

Defined in

packages/schema/src/types.ts:42 (opens in a new tab)


typeDefs

typeDefs: TypeSource

The type definitions used to create the schema

Defined in

packages/schema/src/types.ts:21 (opens in a new tab)


updateResolversInPlace

Optional updateResolversInPlace: boolean

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

Defined in

packages/schema/src/types.ts:38 (opens in a new tab)