graphql-tools-monorepo / federation/src / GetStitchedSchemaFromSupergraphSdlOpts
Interface: GetStitchedSchemaFromSupergraphSdlOpts
federation/src.GetStitchedSchemaFromSupergraphSdlOpts
Hierarchy
-
GetStitchingOptionsFromSupergraphSdlOpts↳
GetStitchedSchemaFromSupergraphSdlOpts
Table of contents
Properties
- batch
- batchDelegateOptions
- batchingOptions
- httpExecutorOpts
- onMergedTypeConfig
- onSubgraphAST
- onSubschemaConfig
- supergraphSdl
Methods
Properties
batch
• Optional batch: boolean
Enable query batching for all subschemas.
Default
falseInherited from
GetStitchingOptionsFromSupergraphSdlOpts.batch
Defined in
packages/federation/src/supergraph.ts:102
batchDelegateOptions
• Optional batchDelegateOptions: Options<any, any, any>
Configure the batch delegation options for all merged types in all subschemas.
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.batchDelegateOptions
Defined in
packages/federation/src/supergraph.ts:110
batchingOptions
• Optional batchingOptions: BatchingOptions<any, any, any>
Configure the query batching options for all subschemas.
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.batchingOptions
Defined in
packages/federation/src/supergraph.ts:106
httpExecutorOpts
• Optional httpExecutorOpts: Partial<HTTPExecutorOptions> | (subgraphInfo: { endpoint?: string ; name: string }) => Partial<HTTPExecutorOptions>
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.httpExecutorOpts
Defined in
packages/federation/src/supergraph.ts:91
onMergedTypeConfig
• Optional onMergedTypeConfig: (typeName: string, mergedTypeConfig: MergedTypeConfig<any, any, Record<string, any>>) => void
Type declaration
▸ (typeName, mergedTypeConfig): void
Parameters
| Name | Type |
|---|---|
typeName | string |
mergedTypeConfig | MergedTypeConfig<any, any, Record<string, any>> |
Returns
void
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.onMergedTypeConfig
Defined in
packages/federation/src/supergraph.ts:95
onSubgraphAST
• Optional onSubgraphAST: (name: string, subgraphAST: DocumentNode) => DocumentNode
Type declaration
▸ (name, subgraphAST): DocumentNode
Parameters
| Name | Type |
|---|---|
name | string |
subgraphAST | DocumentNode |
Returns
DocumentNode
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.onSubgraphAST
Defined in
packages/federation/src/supergraph.ts:96
onSubschemaConfig
• Optional onSubschemaConfig: (subschemaConfig: FederationSubschemaConfig) => void
Type declaration
▸ (subschemaConfig): void
Parameters
| Name | Type |
|---|---|
subschemaConfig | FederationSubschemaConfig |
Returns
void
Inherited from
GetStitchingOptionsFromSupergraphSdlOpts.onSubschemaConfig
Defined in
packages/federation/src/supergraph.ts:94
supergraphSdl
• supergraphSdl: string | DocumentNode
Overrides
GetStitchingOptionsFromSupergraphSdlOpts.supergraphSdl
Defined in
packages/federation/src/supergraph.ts:1212
Methods
onStitchingOptions
▸ onStitchingOptions(opts): void
Parameters
| Name | Type | Default value |
|---|---|---|
opts | Object | undefined |
opts.assumeValid | boolean | true |
opts.assumeValidSDL | boolean | true |
opts.subschemas | SubschemaConfig<any, any, any, Record<string, any>>[] | undefined |
opts.typeDefs | DocumentNode | additionalTypeDefs |
opts.typeMergingOptions | Object | undefined |
opts.typeMergingOptions.fieldConfigMerger | (candidates: MergeFieldConfigCandidate<Record<string, any>>[]) => GraphQLFieldConfig<any, Record<string, any>, any> | undefined |
opts.typeMergingOptions.useNonNullableFieldOnConflict | boolean | true |
opts.typeMergingOptions.validationSettings | Object | undefined |
opts.typeMergingOptions.validationSettings.validationLevel | ValidationLevel | ValidationLevel.Off |
Returns
void