@graphql-tools/utils

Table of contents

References

• extractExtensionsFromSchema
• withCancel

Enumerations

• DirectiveLocation
• MapperKind

Interfaces

• DirectiveAnnotation
• ExecutionRequest
• ExecutionResult
• FieldsAndPatches
• GetDocumentNodeFromSchemaOptions
• GraphQLParseOptions
• IAddResolversToSchemaOptions
• IFieldResolverOptions
• IResolverValidationOptions
• Loader
• Observable
• Observer
• PatchFields
• Path
• PruneSchemaOptions
• SchemaMapper
• SchemaPrintOptions
• Source

Type Aliases

• ASTVisitorKeyMap
• AbstractTypeMapper
• ArgumentFilter
• ArgumentMapper
• ArgumentToDirectives
• AsyncExecutor
• BaseLoaderOptions
• Callback
• CompositeTypeMapper
• Constructor
• DirectiveArgs
• DirectiveLocationEnum
• DirectiveMapper
• DirectiveUsage
• ElementOf
• EnumTypeExtensions
• EnumTypeMapper
• EnumValueMapper
• ErrorVisitor
• ErrorVisitorMap
• Executor
• ExtensionsObject
• FieldFilter
• FieldMapper
• FieldNodeMapper
• FieldNodeMappers
• Force
• GenericFieldMapper
• IDefaultValueIteratorFn
• IEnumTypeResolver
• IFieldIteratorFn
• IFieldResolver
• IInputObjectTypeResolver
• IInterfaceTypeResolver
• IObjectTypeResolver
• IResolvers
• IScalarTypeResolver
• ISchemaLevelResolver
• IUnionTypeResolver
• Ignore
• InputFieldFilter
• InputFieldMapper
• InputLeafValueTransformer
• InputObjectTypeMapper
• InputObjectValueTransformer
• InputTypeExtensions
• InterfaceTypeExtensions
• InterfaceTypeMapper
• Maybe
• MaybeAsyncIterable
• MaybePromise
• NamedDefinitionNode
• NamedTypeMapper
• NextResolverFn
• ObjectFieldFilter
• ObjectTypeExtensions
• ObjectTypeMapper
• ObjectValueVisitor
• PossibleTypeExtensions
• PrintSchemaWithDirectivesOptions
• PruneSchemaFilter
• RenameTypesOptions
• ResultVisitorMap
• RootFieldFilter
• ScalarTypeExtensions
• ScalarTypeMapper
• SchemaExtensions
• SchemaFieldMapperTypes
• SelectedFields
• Skip
• SyncExecutor
• TypeAndFieldToArgumentDirectives
• TypeAndFieldToDirectives
• TypeFilter
• TypeSource
• UnionTypeExtensions
• UnionTypeMapper
• ValidationRule
• ValidatorBehavior
• ValueVisitor
• VisitableSchemaType
• WithList

Variables

• GraphQLDeferDirective
• GraphQLStreamDirective

Functions

• addPath
• addTypes
• appendObjectFields
• asArray
• assertSome
• astFromArg
• astFromDirective
• astFromEnumType
• astFromEnumValue
• astFromField
• astFromInputField
• astFromInputObjectType
• astFromInterfaceType
• astFromObjectType
• astFromScalarType
• astFromSchema
• astFromUnionType
• astFromValueUntyped
• buildOperationNodeForField
• collectComment
• collectFields
• collectSubFields
• compareNodes
• compareStrings
• correctASTNodes
• createDefaultRules
• createGraphQLError
• createNamedStub
• createStub
• createVariableNameGenerator
• dedentBlockStringValue
• doesFragmentConditionMatch
• filterSchema
• fixSchemaAst
• forEachDefaultValue
• forEachField
• getArgumentValues
• getArgumentsWithDirectives
• getAsyncIterableWithCancel
• getAsyncIteratorWithCancel
• getBlockStringIndentation
• getBuiltInForStub
• getComment
• getDeferValues
• getDefinedRootType
• getDeprecatableDirectiveNodes
• getDescription
• getDirective
• getDirectiveInExtensions
• getDirectiveNodes
• getDirectives
• getDirectivesInExtensions
• getDocumentNodeFromSchema
• getFieldEntryKey
• getFieldsWithDirectives
• getImplementingTypes
• getLeadingCommentBlock
• getOperationASTFromDocument
• getOperationASTFromRequest
• getResolversFromSchema
• getResponseKeyFromInfo
• getRootTypeMap
• getRootTypeNames
• getRootTypes
• hasOwnProperty
• healSchema
• healTypes
• implementsAbstractType
• inspect
• isAsyncIterable
• isDescribable
• isDocumentNode
• isDocumentString
• isIterableObject
• isNamedStub
• isObjectLike
• isPromise
• isSome
• isValidPath
• makeDeprecatedDirective
• makeDirectiveNode
• makeDirectiveNodes
• mapAsyncIterator
• mapSchema
• memoize1
• memoize2
• memoize2of4
• memoize2of5
• memoize3
• memoize4
• memoize5
• mergeDeep
• modifyObjectFields
• nodeToString
• observableToAsyncIterable
• parseGraphQLJSON
• parseGraphQLSDL
• parseInputValue
• parseInputValueLiteral
• parseSelectionSet
• pathToArray
• printComment
• printPathArray
• printSchemaWithDirectives
• printWithComments
• promiseReduce
• pruneSchema
• pushComment
• relocatedError
• removeObjectFields
• renameType
• resetComments
• rewireTypes
• selectObjectFields
• serializeInputValue
• shouldIncludeNode
• transformCommentsToDescriptions
• transformInputValue
• updateArgument
• validateGraphQlDocuments
• valueMatchesCriteria
• visitData
• visitErrors
• visitResult

References

extractExtensionsFromSchema

Re-exports extractExtensionsFromSchema

withCancel

Renames and re-exports getAsyncIterableWithCancel

Type Aliases

ASTVisitorKeyMap

Ƭ ASTVisitorKeyMap: Partial<Parameters<typeof visit>[2]>

Defined in

packages/utils/src/types.ts:64 (opens in a new tab)

AbstractTypeMapper

Ƭ AbstractTypeMapper: (type: GraphQLInterfaceType | GraphQLUnionType, schema: GraphQLSchema) => GraphQLInterfaceType | GraphQLUnionType | null | undefined

Type declaration

▸ (type, schema): GraphQLInterfaceType | GraphQLUnionType | null | undefined

Parameters

Returns

GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

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

ArgumentFilter

Ƭ ArgumentFilter: (typeName?: string, fieldName?: string, argName?: string, argConfig?: GraphQLArgumentConfig) => boolean

Type declaration

▸ (typeName?, fieldName?, argName?, argConfig?): boolean

Parameters

Returns

boolean

Defined in

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

ArgumentMapper

Ƭ ArgumentMapper: (argumentConfig: GraphQLArgumentConfig, fieldName: string, typeName: string, schema: GraphQLSchema) => GraphQLArgumentConfig | [string, GraphQLArgumentConfig] | null | undefined

Type declaration

▸ (argumentConfig, fieldName, typeName, schema): GraphQLArgumentConfig | [string, GraphQLArgumentConfig] | null | undefined

Parameters

Returns

GraphQLArgumentConfig | [string, GraphQLArgumentConfig] | null | undefined

Defined in

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

ArgumentToDirectives

Ƭ ArgumentToDirectives: Object

Index signature

▪ [argumentName: string]: DirectiveUsage[]

Defined in

packages/utils/src/get-arguments-with-directives.ts:9 (opens in a new tab)

AsyncExecutor

Ƭ AsyncExecutor<TBaseContext, TBaseExtensions>: <TReturn, TArgs, TContext, TRoot, TExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions, TReturn>) => Promise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Type parameters

Type declaration

▸ <TReturn, TArgs, TContext, TRoot, TExtensions>(request): Promise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Type parameters

Parameters

Returns

Promise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Defined in

packages/utils/src/executor.ts:6 (opens in a new tab)

BaseLoaderOptions

Ƭ BaseLoaderOptions: GraphQLParseOptions & BuildSchemaOptions & { cwd?: string ; ignore?: string | string[] ; includeSources?: boolean }

Defined in

packages/utils/src/loaders.ts:11 (opens in a new tab)

Callback

Ƭ Callback: (value?: any) => any

Type declaration

▸ (value?): any

Parameters

Returns

any

Defined in

packages/utils/src/observableToAsyncIterable.ts:13 (opens in a new tab)

CompositeTypeMapper

Ƭ CompositeTypeMapper: (type: GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType, schema: GraphQLSchema) => GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | null | undefined

Type declaration

▸ (type, schema): GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | null | undefined

Parameters

Returns

GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

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

Constructor

Ƭ Constructor<T>: (...args: any[]) => T

Type parameters

Type declaration

• (...args)

Parameters

Defined in

packages/utils/src/types.ts:24 (opens in a new tab)

DirectiveArgs

Ƭ DirectiveArgs: Object

Index signature

▪ [name: string]: any

Defined in

packages/utils/src/types.ts:135 (opens in a new tab)

DirectiveLocationEnum

Ƭ DirectiveLocationEnum: typeof DirectiveLocation

Defined in

packages/utils/src/types.ts:66 (opens in a new tab)

DirectiveMapper

Ƭ DirectiveMapper: (directive: GraphQLDirective, schema: GraphQLSchema) => GraphQLDirective | null | undefined

Type declaration

▸ (directive, schema): GraphQLDirective | null | undefined

Parameters

Returns

GraphQLDirective | null | undefined

Defined in

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

DirectiveUsage

Ƭ DirectiveUsage: Object

Type declaration

Defined in

packages/utils/src/types.ts:136 (opens in a new tab)

ElementOf

Ƭ ElementOf<TList>: TList extends infer TElement[] ? TElement : never

Type parameters

Defined in

packages/utils/src/loaders.ts:19 (opens in a new tab)

EnumTypeExtensions

Ƭ EnumTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:117 (opens in a new tab)

EnumTypeMapper

Ƭ EnumTypeMapper: (type: GraphQLEnumType, schema: GraphQLSchema) => GraphQLEnumType | null | undefined

Type declaration

▸ (type, schema): GraphQLEnumType | null | undefined

Parameters

Returns

GraphQLEnumType | null | undefined

Defined in

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

EnumValueMapper

Ƭ EnumValueMapper: (valueConfig: GraphQLEnumValueConfig, typeName: string, schema: GraphQLSchema, externalValue: string) => GraphQLEnumValueConfig | [string, GraphQLEnumValueConfig] | null | undefined

Type declaration

▸ (valueConfig, typeName, schema, externalValue): GraphQLEnumValueConfig | [string, GraphQLEnumValueConfig] | null | undefined

Parameters

Returns

GraphQLEnumValueConfig | [string, GraphQLEnumValueConfig] | null | undefined

Defined in

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

ErrorVisitor

Ƭ ErrorVisitor: (error: GraphQLError, pathIndex: number) => GraphQLError

Type declaration

▸ (error, pathIndex): GraphQLError

Parameters

Returns

GraphQLError

Defined in

packages/utils/src/visitResult.ts:33 (opens in a new tab)

ErrorVisitorMap

Ƭ ErrorVisitorMap: { __unpathed?: (error: GraphQLError) => GraphQLError } & Record<string, Record<string, ErrorVisitor>>

Defined in

packages/utils/src/visitResult.ts:35 (opens in a new tab)

Executor

Ƭ Executor<TBaseContext, TBaseExtensions>: <TReturn, TArgs, TContext, TRoot, TExtensions>(request: ExecutionRequest<TArgs, TContext, TRoot, TExtensions, TReturn>) => MaybePromise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Type parameters

Type declaration

▸ <TReturn, TArgs, TContext, TRoot, TExtensions>(request): MaybePromise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Type parameters

Parameters

Returns

MaybePromise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Defined in

packages/utils/src/executor.ts:26 (opens in a new tab)

ExtensionsObject

Ƭ ExtensionsObject: Record<string, any>

Defined in

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

FieldFilter

Ƭ FieldFilter: (typeName: string, fieldName: string, fieldConfig: GraphQLFieldConfig<any, any> | GraphQLInputFieldConfig) => boolean

Type declaration

▸ (typeName, fieldName, fieldConfig): boolean

Parameters

Returns

boolean

Defined in

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

FieldMapper

Ƭ FieldMapper: GenericFieldMapper<GraphQLFieldConfig<any, any>>

Defined in

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

FieldNodeMapper

Ƭ FieldNodeMapper: (fieldNode: FieldNode, fragments: Record<string, FragmentDefinitionNode>, transformationContext: Record<string, any>) => SelectionNode | SelectionNode[]

Type declaration

▸ (fieldNode, fragments, transformationContext): SelectionNode | SelectionNode[]

Parameters

Returns

SelectionNode | SelectionNode[]

Defined in

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

FieldNodeMappers

Ƭ FieldNodeMappers: Record<string, Record<string, FieldNodeMapper>>

Defined in

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

Force

Ƭ Force: string[]

Defined in

packages/utils/src/build-operation-for-field.ts:49 (opens in a new tab)

GenericFieldMapper

Ƭ GenericFieldMapper<F>: (fieldConfig: F, fieldName: string, typeName: string, schema: GraphQLSchema) => F | [string, F] | null | undefined

Type parameters

Type declaration

▸ (fieldConfig, fieldName, typeName, schema): F | [string, F] | null | undefined

Parameters

Returns

F | [string, F] | null | undefined

Defined in

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

IDefaultValueIteratorFn

Ƭ IDefaultValueIteratorFn: (type: GraphQLInputType, value: any) => void

Type declaration

▸ (type, value): void

Parameters

Returns

void

Defined in

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

IEnumTypeResolver

Ƭ IEnumTypeResolver: Record<string, any> & { __astNode?: EnumTypeDefinitionNode ; __description?: string ; __extensionASTNodes?: EnumTypeExtensionNode[] ; __extensions?: Record<string, any> ; __name?: string }

Defined in

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

IFieldIteratorFn

Ƭ IFieldIteratorFn: (fieldDef: GraphQLField<any, any>, typeName: string, fieldName: string) => void

Type declaration

▸ (fieldDef, typeName, fieldName): void

Parameters

Returns

void

Defined in

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

IFieldResolver

Ƭ IFieldResolver<TSource, TContext, TArgs, TReturn>: (source: TSource, args: TArgs, context: TContext, info: GraphQLResolveInfo) => TReturn

Type parameters

Type declaration

▸ (source, args, context, info): TReturn

Parameters

Returns

TReturn

Defined in

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

IInputObjectTypeResolver

Ƭ IInputObjectTypeResolver: Object

Type declaration

Defined in

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

IInterfaceTypeResolver

Ƭ IInterfaceTypeResolver<TSource, TContext, TArgs>: { [key: string]: IFieldResolver<TSource, TContext, TArgs> | IFieldResolverOptions<TSource, TContext>; } & { __astNode?: InterfaceTypeDefinitionNode ; __description?: string ; __extensionASTNodes?: InterfaceTypeExtensionNode[] ; __extensions?: Record<string, any> ; __name?: string ; __resolveType?: GraphQLTypeResolver<any, any> }

Type parameters

Defined in

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

IObjectTypeResolver

Ƭ IObjectTypeResolver<TSource, TContext, TArgs>: { [key: string]: IFieldResolver<TSource, TContext, TArgs> | IFieldResolverOptions<TSource, TContext>; } & { __astNode?: ObjectTypeDefinitionNode ; __description?: string ; __extensionASTNodes?: ObjectTypeExtensionNode ; __extensions?: Record<string, any> ; __isTypeOf?: GraphQLIsTypeOfFn<TSource, TContext> ; __name?: string }

Type parameters

Defined in

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

IResolvers

Ƭ IResolvers<TSource, TContext, TArgs, TReturn>: Record<string, ISchemaLevelResolver<TSource, TContext, TArgs, TReturn> | IObjectTypeResolver<TSource, TContext> | IInterfaceTypeResolver<TSource, TContext> | IUnionTypeResolver | IScalarTypeResolver | IEnumTypeResolver | IInputObjectTypeResolver>

Type parameters

Defined in

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

IScalarTypeResolver

Ƭ IScalarTypeResolver: GraphQLScalarType & { __astNode?: ScalarTypeDefinitionNode ; __description?: string ; __extensionASTNodes?: ScalarTypeExtensionNode[] ; __extensions?: Record<string, any> ; __name?: string ; __parseLiteral?: GraphQLScalarLiteralParser<any> ; __parseValue?: GraphQLScalarValueParser<any> ; __serialize?: GraphQLScalarSerializer<any> }

Defined in

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

ISchemaLevelResolver

Ƭ ISchemaLevelResolver<TSource, TContext, TArgs, TReturn>: IFieldResolver<TSource, TContext, TArgs, TReturn>

Type parameters

Defined in

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

IUnionTypeResolver

Ƭ IUnionTypeResolver: Object

Type declaration

Defined in

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

Ignore

Ƭ Ignore: string[]

Defined in

packages/utils/src/build-operation-for-field.ts:50 (opens in a new tab)

InputFieldFilter

Ƭ InputFieldFilter: (typeName?: string, fieldName?: string, inputFieldConfig?: GraphQLInputFieldConfig) => boolean

Type declaration

▸ (typeName?, fieldName?, inputFieldConfig?): boolean

Parameters

Returns

boolean

Defined in

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

InputFieldMapper

Ƭ InputFieldMapper: GenericFieldMapper<GraphQLInputFieldConfig>

Defined in

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

InputLeafValueTransformer

Ƭ InputLeafValueTransformer: (type: GraphQLEnumType | GraphQLScalarType, originalValue: any) => any

Type declaration

▸ (type, originalValue): any

Parameters

Returns

any

Defined in

packages/utils/src/types.ts:57 (opens in a new tab)

InputObjectTypeMapper

Ƭ InputObjectTypeMapper: (type: GraphQLInputObjectType, schema: GraphQLSchema) => GraphQLInputObjectType | null | undefined

Type declaration

▸ (type, schema): GraphQLInputObjectType | null | undefined

Parameters

Returns

GraphQLInputObjectType | null | undefined

Defined in

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

InputObjectValueTransformer

Ƭ InputObjectValueTransformer: (type: GraphQLInputObjectType, originalValue: Record<string, any>) => Record<string, any>

Type declaration

▸ (type, originalValue): Record<string, any>

Parameters

Returns

Record<string, any>

Defined in

packages/utils/src/types.ts:58 (opens in a new tab)

InputTypeExtensions

Ƭ InputTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:99 (opens in a new tab)

InterfaceTypeExtensions

Ƭ InterfaceTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:104 (opens in a new tab)

InterfaceTypeMapper

Ƭ InterfaceTypeMapper: (type: GraphQLInterfaceType, schema: GraphQLSchema) => GraphQLInterfaceType | null | undefined

Type declaration

▸ (type, schema): GraphQLInterfaceType | null | undefined

Parameters

Returns

GraphQLInterfaceType | null | undefined

Defined in

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

Maybe

Ƭ Maybe<T>: null | undefined | T

Type parameters

Defined in

packages/utils/src/types.ts:22 (opens in a new tab)

MaybeAsyncIterable

Ƭ MaybeAsyncIterable<T>: AsyncIterable<T> | T

Type parameters

Defined in

packages/utils/src/executor.ts:4 (opens in a new tab)

MaybePromise

Ƭ MaybePromise<T>: PromiseLike<T> | T

Type parameters

Defined in

packages/utils/src/executor.ts:3 (opens in a new tab)

NamedDefinitionNode

Ƭ NamedDefinitionNode: DefinitionNode & { name?: NameNode }

Defined in

packages/utils/src/comments.ts:16 (opens in a new tab)

NamedTypeMapper

Ƭ NamedTypeMapper: (type: GraphQLNamedType, schema: GraphQLSchema) => GraphQLNamedType | null | undefined

Type declaration

▸ (type, schema): GraphQLNamedType | null | undefined

Parameters

Returns

GraphQLNamedType | null | undefined

Defined in

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

NextResolverFn

Ƭ NextResolverFn: () => Promise<any>

Type declaration

▸ (): Promise<