Skip to Content
GraphQL Tools
DocumentationAPI@graphql-tools/loadsrctype-aliasesLoadSchemaOptions

Type Alias: LoadSchemaOptions

LoadSchemaOptions = BuildSchemaOptions & LoadTypedefsOptions & Partial<IExecutableSchemaDefinition> & object

Defined in: packages/load/src/schema.ts:30 

Type Declaration

includeSources?

optional includeSources?: boolean

Adds a list of Sources in to extensions.sources

Disabled by default.

sortMode?

optional sortMode?: SchemaSortMode

How to sort the schema when sort is true.

lexicographic (default) uses GraphQL’s lexicographicSortSchema. Types, fields, arguments, and enum values are all reordered.

typesOnly sorts only the type list. Field and enum value order stay as loaded.

Example

Given:

enum DayOfWeek { SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY } type Query { d: String z: String a: String day: DayOfWeek }

sort: true:

enum DayOfWeek { FRIDAY MONDAY SATURDAY SUNDAY THURSDAY TUESDAY WEDNESDAY } type Query { a: String d: String day: DayOfWeek z: String }

sort: true, sortMode: 'typesOnly':

enum DayOfWeek { SUNDAY MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY } type Query { d: String z: String a: String day: DayOfWeek }

sort: false ignores sortMode.