@graphql-tools/delegate

Table of contents

Classes

• Subschema
• Transformer

Interfaces

• BatchingOptions
• DelegationContext
• ExternalObject
• ICreateProxyingResolverOptions
• ICreateRequest
• IDelegateRequestOptions
• IDelegateToSchemaOptions
• MergedFieldConfig
• MergedTypeConfig
• MergedTypeEntryPoint
• MergedTypeInfo
• MergedTypeResolverOptions
• StitchingInfo
• SubschemaConfig
• Transform

Type Aliases

• CreateProxyingResolverFn
• DelegationPlanBuilder
• MergedTypeResolver
• RequestTransform
• ResultTransform
• SchemaTransform

Functions

• annotateExternalObject
• applySchemaTransforms
• cloneSubschemaConfig
• createDefaultExecutor
• createRequest
• defaultMergedResolver
• delegateRequest
• delegateToSchema
• getActualFieldNodes
• getDelegatingOperation
• getSubschema
• getUnpathedErrors
• isExternalObject
• isSubschema
• isSubschemaConfig
• mergeFields
• resolveExternalValue

Type Aliases

CreateProxyingResolverFn

Ƭ CreateProxyingResolverFn<TContext>: (options: ICreateProxyingResolverOptions<TContext>) => GraphQLFieldResolver<any, TContext>

Type parameters

Type declaration

▸ (options): GraphQLFieldResolver<any, TContext>

Parameters

Returns

GraphQLFieldResolver<any, TContext>

Defined in

packages/delegate/src/types.ts:129 (opens in a new tab)

DelegationPlanBuilder

Ƭ DelegationPlanBuilder: (schema: GraphQLSchema, sourceSubschema: Subschema<any, any, any, any>, variableValues: Record<string, any>, fragments: Record<string, FragmentDefinitionNode>, fieldNodes: FieldNode[]) => Map<Subschema, SelectionSetNode>[]

Type declaration

▸ (schema, sourceSubschema, variableValues, fragments, fieldNodes): Map<Subschema, SelectionSetNode>[]

Parameters

Returns

Map<Subschema, SelectionSetNode>[]

Defined in

packages/delegate/src/types.ts:102 (opens in a new tab)

MergedTypeResolver

Ƭ MergedTypeResolver<TContext>: (originalResult: any, context: TContext, info: GraphQLResolveInfo, subschema: Subschema<any, any, any, TContext>, selectionSet: SelectionSetNode, key: any | undefined, type: GraphQLOutputType) => any

Type parameters

Type declaration

▸ (originalResult, context, info, subschema, selectionSet, key, type): any

Parameters

Returns

any

Defined in

packages/delegate/src/types.ts:176 (opens in a new tab)

RequestTransform

Ƭ RequestTransform<T, TContext>: (originalRequest: ExecutionRequest, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionRequest

Type parameters

Type declaration

▸ (originalRequest, delegationContext, transformationContext): ExecutionRequest

Parameters

Returns

ExecutionRequest

Defined in

packages/delegate/src/types.ts:27 (opens in a new tab)

ResultTransform

Ƭ ResultTransform<T, TContext>: (originalResult: ExecutionResult, delegationContext: DelegationContext<TContext>, transformationContext: T) => ExecutionResult

Type parameters

Type declaration

▸ (originalResult, delegationContext, transformationContext): ExecutionResult

Parameters

Returns

ExecutionResult

Defined in

packages/delegate/src/types.ts:32 (opens in a new tab)

SchemaTransform

Ƭ SchemaTransform<TContext>: (originalWrappingSchema: GraphQLSchema, subschemaConfig: SubschemaConfig<any, any, any, TContext>) => GraphQLSchema

Type parameters

Type declaration

▸ (originalWrappingSchema, subschemaConfig): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/delegate/src/types.ts:23 (opens in a new tab)

Functions

annotateExternalObject

▸ annotateExternalObject<TContext>(object, errors, subschema, subschemaMap): ExternalObject

Type parameters

Parameters

Returns

ExternalObject

Defined in

packages/delegate/src/mergeFields.ts:23 (opens in a new tab)

applySchemaTransforms

▸ applySchemaTransforms(originalWrappingSchema, subschemaConfig): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/delegate/src/applySchemaTransforms.ts:7 (opens in a new tab)

cloneSubschemaConfig

▸ cloneSubschemaConfig(subschemaConfig): SubschemaConfig

Parameters

Returns

SubschemaConfig

Defined in

packages/delegate/src/subschemaConfig.ts:7 (opens in a new tab)

createDefaultExecutor

▸ createDefaultExecutor(schema): Executor

Parameters

Returns

Executor

Defined in

packages/delegate/src/delegateToSchema.ts:223 (opens in a new tab)

createRequest

▸ createRequest(«destructured»): ExecutionRequest

Parameters

Returns

ExecutionRequest

Defined in

packages/delegate/src/createRequest.ts:38 (opens in a new tab)

defaultMergedResolver

▸ defaultMergedResolver(parent, args, context, info): any

Resolver that knows how to: a) handle aliases for proxied schemas b) handle errors from proxied schemas c) handle external to internal enum conversion

Parameters

Returns

any

Defined in

packages/delegate/src/defaultMergedResolver.ts:15 (opens in a new tab)

delegateRequest

▸ delegateRequest<TContext, TArgs>(options): any

Type parameters

Parameters

Returns

any

Defined in

packages/delegate/src/delegateToSchema.ts:92 (opens in a new tab)

delegateToSchema

▸ delegateToSchema<TContext, TArgs>(options): any

Type parameters

Parameters

Returns

any

Defined in

packages/delegate/src/delegateToSchema.ts:40 (opens in a new tab)

getActualFieldNodes

▸ getActualFieldNodes(fieldNode): FieldNode[]

Parameters

Returns

FieldNode[]

Defined in

packages/delegate/src/mergeFields.ts:52 (opens in a new tab)

getDelegatingOperation

▸ getDelegatingOperation(parentType, schema): OperationTypeNode

Parameters

Returns

OperationTypeNode

Defined in

packages/delegate/src/createRequest.ts:28 (opens in a new tab)

getSubschema

▸ getSubschema(object, responseKey): GraphQLSchema | SubschemaConfig

Parameters

Returns

GraphQLSchema | SubschemaConfig

Defined in

packages/delegate/src/mergeFields.ts:37 (opens in a new tab)

getUnpathedErrors

▸ getUnpathedErrors(object): GraphQLError[]

Parameters

Returns

GraphQLError[]

Defined in

packages/delegate/src/mergeFields.ts:41 (opens in a new tab)

isExternalObject

▸ isExternalObject(data): data is ExternalObject<Record<string, any>>

Parameters

Returns

data is ExternalObject<Record<string, any>>

Defined in

packages/delegate/src/mergeFields.ts:19 (opens in a new tab)

isSubschema

▸ isSubschema(value): value is Subschema<any, any, any, Record<string, any>>

Parameters

Returns

value is Subschema<any, any, any, Record<string, any>>

Defined in

packages/delegate/src/Subschema.ts:8 (opens in a new tab)

isSubschemaConfig

▸ isSubschemaConfig(value): value is SubschemaConfig<any, any, any, any>

Parameters

Returns

value is SubschemaConfig<any, any, any, any>

Defined in

packages/delegate/src/subschemaConfig.ts:3 (opens in a new tab)

mergeFields

▸ mergeFields<TContext>(mergedTypeInfo, object, sourceSubschema, context, info): ValueOrPromise<any>

Type parameters

Parameters

Returns

ValueOrPromise<any>

Defined in

packages/delegate/src/mergeFields.ts:56 (opens in a new tab)

resolveExternalValue

▸ resolveExternalValue<TContext>(result, unpathedErrors, subschema, context?, info?, returnType?, skipTypeMerging?): any

Type parameters

Parameters

Returns

any

Defined in

packages/delegate/src/resolveExternalValue.ts:21 (opens in a new tab)