graphql-tools-monorepo / schema/src / IExecutableSchemaDefinition
Interface: IExecutableSchemaDefinition<TContext>
schema/src.IExecutableSchemaDefinition
Configuration object for creating an executable schema
Type parameters
| Name | Type |
|---|---|
TContext | any |
Hierarchy
-
BuildSchemaOptions -
↳
IExecutableSchemaDefinition
Table of contents
Properties
- allowLegacySDLEmptyFields
- allowLegacySDLImplementsInterfaces
- assumeValid
- assumeValidSDL
- commentDescriptions
- defaultFieldResolver
- experimentalFragmentVariables
- inheritResolversFromInterfaces
- noLocation
- resolverValidationOptions
- resolvers
- schemaExtensions
- typeDefs
- updateResolversInPlace
Properties
allowLegacySDLEmptyFields
• Optional allowLegacySDLEmptyFields: boolean
Inherited from
GraphQLParseOptions.allowLegacySDLEmptyFields
Defined in
packages/utils/src/Interfaces.ts:95
allowLegacySDLImplementsInterfaces
• Optional allowLegacySDLImplementsInterfaces: boolean
Inherited from
GraphQLParseOptions.allowLegacySDLImplementsInterfaces
Defined in
packages/utils/src/Interfaces.ts:96
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:103
defaultFieldResolver
• Optional defaultFieldResolver: GraphQLFieldResolver<any, TContext>
Default field resolver
Defined in
packages/schema/src/types.ts:48
experimentalFragmentVariables
• Optional experimentalFragmentVariables: boolean
Inherited from
GraphQLParseOptions.experimentalFragmentVariables
Defined in
packages/utils/src/Interfaces.ts:97
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:36
noLocation
• Optional noLocation: boolean
Inherited from
GraphQLParseOptions.noLocation
Defined in
packages/utils/src/Interfaces.ts:94
resolverValidationOptions
• Optional resolverValidationOptions: IResolverValidationOptions
Additional options for validating the provided resolvers
Defined in
packages/schema/src/types.ts:31
resolvers
• Optional resolvers: IResolvers<any, TContext> | IResolvers<any, TContext>[]
Object describing the field resolvers for the provided type definitions
Defined in
packages/schema/src/types.ts:27
schemaExtensions
• Optional schemaExtensions: SchemaExtensions | SchemaExtensions[]
Schema extensions
Defined in
packages/schema/src/types.ts:44
typeDefs
• typeDefs: TypeSource
The type definitions used to create the schema
Defined in
packages/schema/src/types.ts:23
updateResolversInPlace
• Optional updateResolversInPlace: boolean
Do not create a schema again and use the one from buildASTSchema