@graphql-tools/utils

References

• extractExtensionsFromSchema
• inspect
• 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
• DirectableGraphQLObject
• 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
• debugTimerEnd
• debugTimerStart
• 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
• isAsyncIterable
• isDescribable
• isDocumentNode
• isDocumentString
• isIterableObject
• isNamedStub
• isObjectLike
• isPromise
• isSome
• isValidPath
• makeDeprecatedDirective
• makeDirectiveNode
• makeDirectiveNodes
• mapAsyncIterator
• mapSchema
• memoize1
• memoize2
• memoize2of4
• memoize2of5
• memoize3
• memoize4
• memoize5
• mergeDeep
• mergeIncrementalResult
• 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

inspect

Re-exports inspect

withCancel

Renames and re-exports getAsyncIterableWithCancel

Type Aliases

ASTVisitorKeyMap

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

Defined in

packages/utils/src/types.ts:74

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:461

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

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:490

ArgumentToDirectives

Ƭ ArgumentToDirectives: Object

Index signature

▪ [argumentName: string]: DirectiveUsage[]

Defined in

packages/utils/src/get-arguments-with-directives.ts:14

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

BaseLoaderOptions

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

Defined in

packages/utils/src/loaders.ts:11

Callback

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

Type declaration

▸ (value?): any

Parameters

Returns

any

Defined in

packages/utils/src/observableToAsyncIterable.ts:13

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:446

Constructor

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

Type parameters

Type declaration

• (...args): T

Parameters

Returns

T

Defined in

packages/utils/src/types.ts:31

DirectableGraphQLObject

Ƭ DirectableGraphQLObject: GraphQLSchema | GraphQLSchemaConfig | GraphQLNamedType | GraphQLObjectTypeConfig<any, any> | GraphQLInterfaceTypeConfig<any, any> | GraphQLUnionTypeConfig<any, any> | GraphQLScalarTypeConfig<any, any> | GraphQLEnumTypeConfig | GraphQLEnumValue | GraphQLEnumValueConfig | GraphQLInputObjectTypeConfig | GraphQLField<any, any> | GraphQLInputField | GraphQLFieldConfig<any, any> | GraphQLInputFieldConfig

Defined in

packages/utils/src/get-directives.ts:42

DirectiveArgs

Ƭ DirectiveArgs: Object

Index signature

▪ [name: string]: any

Defined in

packages/utils/src/types.ts:151

DirectiveLocationEnum

Ƭ DirectiveLocationEnum: typeof DirectiveLocation

Defined in

packages/utils/src/types.ts:76

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:476

DirectiveUsage

Ƭ DirectiveUsage: Object

Type declaration

Defined in

packages/utils/src/types.ts:152

ElementOf

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

Type parameters

Defined in

packages/utils/src/loaders.ts:19

EnumTypeExtensions

Ƭ EnumTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:133

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:434

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:439

ErrorVisitor

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

Type declaration

▸ (error, pathIndex): GraphQLError

Parameters

Returns

GraphQLError

Defined in

packages/utils/src/visitResult.ts:32

ErrorVisitorMap

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

Defined in

packages/utils/src/visitResult.ts:34

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:32

ExtensionsObject

Ƭ ExtensionsObject: Record<string, any>

Defined in

packages/utils/src/types.ts:102

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

FieldMapper

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

Defined in

packages/utils/src/Interfaces.ts:488

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

FieldNodeMappers

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

Defined in

packages/utils/src/Interfaces.ts:210

Force

Ƭ Force: string[]

Defined in

packages/utils/src/build-operation-for-field.ts:48

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:481

IDefaultValueIteratorFn

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

Type declaration

▸ (type, value): void

Parameters

Returns

void

Defined in

packages/utils/src/Interfaces.ts:338

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

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:332

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

IInputObjectTypeResolver

Ƭ IInputObjectTypeResolver: Object

Type declaration

Defined in

packages/utils/src/Interfaces.ts:301

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:279

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

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:316

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

ISchemaLevelResolver

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

Type parameters

Defined in

packages/utils/src/Interfaces.ts:309

IUnionTypeResolver

Ƭ IUnionTypeResolver: Object

Type declaration

Defined in

packages/utils/src/Interfaces.ts:292

Ignore

Ƭ Ignore: string[]

Defined in

packages/utils/src/build-operation-for-field.ts:49

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

InputFieldMapper

Ƭ InputFieldMapper: GenericFieldMapper<GraphQLInputFieldConfig>

Defined in

packages/utils/src/Interfaces.ts:497

InputLeafValueTransformer

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

Type declaration

▸ (type, originalValue): any

Parameters

Returns

any

Defined in

packages/utils/src/types.ts:64

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:456

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:68

InputTypeExtensions

Ƭ InputTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:112

InterfaceTypeExtensions

Ƭ InterfaceTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:117

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:471

Maybe

Ƭ Maybe<T>: null | undefined | T

Type parameters

Defined in

packages/utils/src/types.ts:29

MaybeAsyncIterable

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

Type parameters

Defined in

packages/utils/src/executor.ts:4

MaybePromise

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

Type parameters

Defined in

packages/utils/src/executor.ts:3

NamedDefinitionNode

Ƭ NamedDefinitionNode: DefinitionNode & { name?: NameNode }

Defined in

packages/utils/src/comments.ts:16

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:424

NextResolverFn

Ƭ NextResolverFn: () => Promise<any>

Type declaration

▸ (): Promise<any>

Returns

Promise<any>

Defined in

packages/utils/src/Interfaces.ts:340

ObjectFieldFilter

Ƭ ObjectFieldFilter: (typeName: string, fieldName: string, fieldConfig: GraphQLFieldConfig<any, any>) => boolean

Type declaration

▸ (typeName, fieldName, fieldConfig): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:224

ObjectTypeExtensions

Ƭ ObjectTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:104

ObjectTypeMapper

Ƭ ObjectTypeMapper: (type: GraphQLObjectType, schema: GraphQLSchema) => GraphQLObjectType | null | undefined

Type declaration

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

Parameters

Returns

GraphQLObjectType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:451

ObjectValueVisitor

Ƭ ObjectValueVisitor: { __enter?: ValueVisitor ; __leave?: ValueVisitor } & Record<string, ValueVisitor>

Defined in

packages/utils/src/visitResult.ts:25

PossibleTypeExtensions

Ƭ PossibleTypeExtensions: InputTypeExtensions | InterfaceTypeExtensions | ObjectTypeExtensions | UnionTypeExtensions | ScalarTypeExtensions | EnumTypeExtensions

Defined in

packages/utils/src/types.ts:138

PrintSchemaWithDirectivesOptions

Ƭ PrintSchemaWithDirectivesOptions: SchemaPrintOptions & GetDocumentNodeFromSchemaOptions

Defined in

packages/utils/src/types.ts:26

PruneSchemaFilter

Ƭ PruneSchemaFilter: (type: GraphQLNamedType) => boolean

Type declaration

▸ (type): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/types.ts:33

RenameTypesOptions

Ƭ RenameTypesOptions: Object

Type declaration

Defined in

packages/utils/src/Interfaces.ts:245

ResultVisitorMap

Ƭ ResultVisitorMap: Record<string, ValueVisitor | ObjectValueVisitor>

Defined in

packages/utils/src/visitResult.ts:30

RootFieldFilter

Ƭ RootFieldFilter: (operation: "Query" | "Mutation" | "Subscription", rootFieldName: string, fieldConfig: GraphQLFieldConfig<any, any>) => boolean

Type declaration

▸ (operation, rootFieldName, fieldConfig): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:230

ScalarTypeExtensions

Ƭ ScalarTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:129

ScalarTypeMapper

Ƭ ScalarTypeMapper: (type: GraphQLScalarType, schema: GraphQLSchema) => GraphQLScalarType | null | undefined

Type declaration

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

Parameters

Returns

GraphQLScalarType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:429

SchemaExtensions

Ƭ SchemaExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:146

SchemaFieldMapperTypes

Ƭ SchemaFieldMapperTypes: (FIELD | COMPOSITE_FIELD | OBJECT_FIELD | ROOT_FIELD | QUERY_ROOT_FIELD | MUTATION_ROOT_FIELD | SUBSCRIPTION_ROOT_FIELD | INTERFACE_FIELD | INPUT_OBJECT_FIELD)[]

Defined in

packages/utils/src/Interfaces.ts:412

SelectedFields

Ƭ SelectedFields: { [key: string]: SelectedFields; } | boolean

Defined in

packages/utils/src/build-operation-for-field.ts:51

Skip

Ƭ Skip: string[]

Defined in

packages/utils/src/build-operation-for-field.ts:47

SyncExecutor

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

Type parameters

Type declaration

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

Type parameters

Parameters

Returns

ExecutionResult<TReturn>

Defined in

packages/utils/src/executor.ts:19

TypeAndFieldToArgumentDirectives

Ƭ TypeAndFieldToArgumentDirectives: Object

Index signature

▪ [typeAndField: string]: ArgumentToDirectives

Defined in

packages/utils/src/get-arguments-with-directives.ts:17

TypeAndFieldToDirectives

Ƭ TypeAndFieldToDirectives: Object

Index signature

▪ [typeAndField: string]: DirectiveUsage[]

Defined in

packages/utils/src/get-fields-with-directives.ts:11

TypeFilter

Ƭ TypeFilter: (typeName: string, type: GraphQLType) => boolean

Type declaration

▸ (typeName, type): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:236

TypeSource

Ƭ TypeSource: string | Source | DocumentNode | GraphQLSchema | DefinitionNode | TypeSource[] | () => TypeSource

Defined in

packages/utils/src/Interfaces.ts:257

UnionTypeExtensions

Ƭ UnionTypeExtensions: Object

Type declaration

Defined in

packages/utils/src/types.ts:125

UnionTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLUnionType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:466

ValidationRule

Ƭ ValidationRule: (context: ValidationContext) => ASTVisitor

Type declaration

▸ (context): ASTVisitor

Parameters

Returns

ASTVisitor

Defined in

packages/utils/src/validate-documents.ts:13

ValidatorBehavior

Ƭ ValidatorBehavior: "error" | "warn" | "ignore"

Defined in

packages/utils/src/Interfaces.ts:108

ValueVisitor

Ƭ ValueVisitor: (value: any) => any

Type declaration

▸ (value): any

Parameters

Returns

any

Defined in

packages/utils/src/visitResult.ts:23

VisitableSchemaType

Ƭ VisitableSchemaType: GraphQLSchema | GraphQLObjectType | GraphQLInterfaceType | GraphQLInputObjectType | GraphQLNamedType | GraphQLScalarType | GraphQLField<any, any> | GraphQLInputField | GraphQLArgument | GraphQLUnionType | GraphQLEnumType | GraphQLEnumValue

Defined in

packages/utils/src/Interfaces.ts:342

WithList

Ƭ WithList<T>: T | T[]

Type parameters

Defined in

packages/utils/src/loaders.ts:18

Variables

GraphQLDeferDirective

• Const GraphQLDeferDirective: GraphQLDirective

Used to conditionally defer fragments.

Defined in

packages/utils/src/directives.ts:13

GraphQLStreamDirective

• Const GraphQLStreamDirective: GraphQLDirective

Used to conditionally stream list fields.

Defined in

packages/utils/src/directives.ts:34

Functions

addPath

▸ addPath(prev, key, typename): Path

Given a Path and a key, return a new Path containing the new key.

Parameters

Returns

Path

Defined in

packages/utils/src/Path.ts:12

addTypes

▸ addTypes(schema, newTypesOrDirectives): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/addTypes.ts:39

appendObjectFields

▸ appendObjectFields(schema, typeName, additionalFields): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/fields.ts:11

asArray

▸ asArray<T>(fns): T[]

Type parameters

Parameters

Returns

T[]

Defined in

packages/utils/src/helpers.ts:3

assertSome

▸ assertSome<T>(input, message?): asserts input is Exclude<T, undefined | null>

Type parameters

Parameters

Returns

asserts input is Exclude<T, undefined | null>

Defined in

packages/utils/src/helpers.ts:75

astFromArg

▸ astFromArg(arg, schema?, pathToDirectivesInExtensions?): InputValueDefinitionNode

Parameters

Returns

InputValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:307

astFromDirective

▸ astFromDirective(directive, schema?, pathToDirectivesInExtensions?): DirectiveDefinitionNode

Parameters

Returns

DirectiveDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:200

astFromEnumType

▸ astFromEnumType(type, schema, pathToDirectivesInExtensions?): EnumTypeDefinitionNode

Parameters

Returns

EnumTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:456

astFromEnumValue

▸ astFromEnumValue(value, schema, pathToDirectivesInExtensions?): EnumValueDefinitionNode

Parameters

Returns

EnumValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:581

astFromField

▸ astFromField(field, schema, pathToDirectivesInExtensions?): FieldDefinitionNode

Parameters

Returns

FieldDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:527

astFromInputField

▸ astFromInputField(field, schema, pathToDirectivesInExtensions?): InputValueDefinitionNode

Parameters

Returns

InputValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:554

astFromInputObjectType

▸ astFromInputObjectType(type, schema, pathToDirectivesInExtensions?): InputObjectTypeDefinitionNode

Parameters

Returns

InputObjectTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:428

astFromInterfaceType

▸ astFromInterfaceType(type, schema, pathToDirectivesInExtensions?): InterfaceTypeDefinitionNode

Parameters

Returns

InterfaceTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:367

astFromObjectType

▸ astFromObjectType(type, schema, pathToDirectivesInExtensions?): ObjectTypeDefinitionNode

Parameters

Returns

ObjectTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:337

astFromScalarType

▸ astFromScalarType(type, schema, pathToDirectivesInExtensions?): ScalarTypeDefinitionNode

Parameters

Returns

ScalarTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:484

astFromSchema

▸ astFromSchema(schema, pathToDirectivesInExtensions?): SchemaDefinitionNode | SchemaExtensionNode | null

Parameters

Returns

SchemaDefinitionNode | SchemaExtensionNode | null

Defined in

packages/utils/src/print-schema-with-directives.ts:124

astFromUnionType

▸ astFromUnionType(type, schema, pathToDirectivesInExtensions?): UnionTypeDefinitionNode

Parameters

Returns

UnionTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:402

astFromValueUntyped

▸ astFromValueUntyped(value): ValueNode | null

Produces a GraphQL Value AST given a JavaScript object. Function will match JavaScript/JSON values to GraphQL AST schema format by using the following mapping.

Parameters

Returns

ValueNode | null

Defined in

packages/utils/src/astFromValueUntyped.ts:19

buildOperationNodeForField

▸ buildOperationNodeForField(«destructured»): OperationDefinitionNode

Parameters

Returns

OperationDefinitionNode

Defined in

packages/utils/src/build-operation-for-field.ts:57

collectComment

▸ collectComment(node): void

Parameters

Returns

void

Defined in

packages/utils/src/comments.ts:28

collectFields

▸ collectFields<TVariables>(schema, fragments, variableValues, runtimeType, selectionSet): FieldsAndPatches

Given a selectionSet, collects all of the fields and returns them.

CollectFields requires the "runtime type" of an object. For a field that returns an Interface or Union type, the "runtime type" will be the actual object type returned by that field.

Type parameters

Parameters

Returns

FieldsAndPatches

Defined in

packages/utils/src/collectFields.ts:152

collectSubFields

▸ collectSubFields(schema, fragments, variableValues, returnType, fieldNodes): FieldsAndPatches

Given an array of field nodes, collects all of the subfields of the passed in fields, and returns them at the end.

CollectSubFields requires the "return type" of an object. For a field that returns an Interface or Union type, the "return type" will be the actual object type returned by that field.

Parameters

Returns

FieldsAndPatches

Defined in

packages/utils/src/collectFields.ts:257

compareNodes

▸ compareNodes(a, b, customFn?): number

Parameters

Returns

number

Defined in

packages/utils/src/helpers.ts:60

compareStrings

▸ compareStrings<A, B>(a, b): 1 | -1 | 0

Type parameters

Parameters

Returns

1 | -1 | 0

Defined in

packages/utils/src/helpers.ts:33

correctASTNodes

▸ correctASTNodes(type): GraphQLObjectType

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/mapSchema.ts:539

▸ correctASTNodes(type): GraphQLInterfaceType

Parameters

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/mapSchema.ts:540

▸ correctASTNodes(type): GraphQLInputObjectType

Parameters

Returns

GraphQLInputObjectType

Defined in

packages/utils/src/mapSchema.ts:541

▸ correctASTNodes(type): GraphQLEnumType

Parameters

Returns

GraphQLEnumType

Defined in

packages/utils/src/mapSchema.ts:542

createDefaultRules

▸ createDefaultRules(): ValidationRule[]

Returns

ValidationRule[]

Defined in

packages/utils/src/validate-documents.ts:46

createGraphQLError

▸ createGraphQLError(message, options?): GraphQLError

Parameters

Returns

GraphQLError

Defined in

packages/utils/src/errors.ts:38

createNamedStub

▸ createNamedStub(name, type): GraphQLObjectType

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/stub.ts:20

▸ createNamedStub(name, type): GraphQLInterfaceType

Parameters

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/stub.ts:21

▸ createNamedStub(name, type): GraphQLInputObjectType

Parameters

Returns

GraphQLInputObjectType

Defined in

packages/utils/src/stub.ts:22

createStub

▸ createStub(node, type): GraphQLOutputType

Parameters

Returns

GraphQLOutputType

Defined in

packages/utils/src/stub.ts:46

▸ createStub(node, type): GraphQLInputType

Parameters

Returns

GraphQLInputType

Defined in

packages/utils/src/stub.ts:47

▸ createStub(node, type): GraphQLType

Parameters

Returns

GraphQLType

Defined in

packages/utils/src/stub.ts:48

createVariableNameGenerator

▸ createVariableNameGenerator(variableDefinitionMap): (argName: string) => string

Parameters

Returns

fn

▸ (argName): string

Parameters

Returns

string

Defined in

packages/utils/src/updateArgument.ts:53

debugTimerEnd

▸ debugTimerEnd(name): void

Parameters

Returns

void

Defined in

packages/utils/src/debugTimer.ts:11

debugTimerStart

▸ debugTimerStart(name): void

Parameters

Returns

void

Defined in

packages/utils/src/debugTimer.ts:3

dedentBlockStringValue

▸ dedentBlockStringValue(rawString): string

Parameters

Returns

string

Defined in

packages/utils/src/comments.ts:492

doesFragmentConditionMatch

▸ doesFragmentConditionMatch(schema, fragment, type): boolean

Determines if a fragment is applicable to the given type.

Parameters

Returns

boolean

Defined in

packages/utils/src/collectFields.ts:197

filterSchema

▸ filterSchema(«destructured»): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/filterSchema.ts:20

fixSchemaAst

▸ fixSchemaAst(schema, options): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/fixSchemaAst.ts:12

forEachDefaultValue

▸ forEachDefaultValue(schema, fn): void

Parameters

Returns

void

Defined in

packages/utils/src/forEachDefaultValue.ts:4

forEachField

▸ forEachField(schema, fn): void

Parameters

Returns

void

Defined in

packages/utils/src/forEachField.ts:4

getArgumentValues

▸ getArgumentValues(def, node, variableValues?): Record<string, any>

Prepares an object map of argument values given a list of argument definitions and list of argument AST nodes.

Note: The returned value is a plain Object with a prototype, since it is exposed to user code. Care should be taken to not pull values from the Object prototype.

Parameters

Returns

Record<string, any>

Defined in

packages/utils/src/getArgumentValues.ts:24

getArgumentsWithDirectives

▸ getArgumentsWithDirectives(documentNode): TypeAndFieldToArgumentDirectives

Parameters

Returns

TypeAndFieldToArgumentDirectives

Defined in

packages/utils/src/get-arguments-with-directives.ts:21

getAsyncIterableWithCancel

▸ getAsyncIterableWithCancel<T, TAsyncIterable, TReturn>(asyncIterable, onCancel): TAsyncIterable

Type parameters

Parameters

Returns

TAsyncIterable

Defined in

packages/utils/src/withCancel.ts:43

getAsyncIteratorWithCancel

▸ getAsyncIteratorWithCancel<T, TReturn>(asyncIterator, onCancel): AsyncIterator<T>

Type parameters

Parameters

Returns

AsyncIterator<T>

Defined in

packages/utils/src/withCancel.ts:16

getBlockStringIndentation

▸ getBlockStringIndentation(lines): number

Parameters

Returns

number

Defined in

packages/utils/src/comments.ts:519

getBuiltInForStub

▸ getBuiltInForStub(type): GraphQLNamedType

Parameters

Returns

GraphQLNamedType

Defined in

packages/utils/src/stub.ts:76

getComment

▸ getComment(node): undefined | string

Parameters

Returns

undefined | string

Defined in

packages/utils/src/comments.ts:463

getDeferValues

▸ getDeferValues(variableValues, node): undefined | { label: string | undefined }

Returns an object containing the @defer arguments if a field should be deferred based on the experimental flag, defer directive present and not disabled by the "if" argument.

Parameters

Returns

undefined | { label: string | undefined }

Defined in

packages/utils/src/collectFields.ts:229

getDefinedRootType

▸ getDefinedRootType(schema, operation, nodes?): GraphQLObjectType

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/rootTypes.ts:5

getDeprecatableDirectiveNodes

▸ getDeprecatableDirectiveNodes(entity, schema?, pathToDirectivesInExtensions?): DirectiveNode[]

Parameters

Returns

DirectiveNode[]

Defined in

packages/utils/src/print-schema-with-directives.ts:265

getDescription

▸ getDescription(node, options?): string | undefined

Parameters

Returns

string | undefined

Defined in

packages/utils/src/comments.ts:451

getDirective

▸ getDirective(schema, node, directiveName, pathToDirectivesInExtensions?): Record<string, any>[] | undefined

Parameters

Returns

Record<string, any>[] | undefined

Defined in

packages/utils/src/get-directives.ts:167

getDirectiveInExtensions

▸ getDirectiveInExtensions(node, directiveName, pathToDirectivesInExtensions?): Record<string, any>[] | undefined

Parameters

Returns

Record<string, any>[] | undefined

Defined in

packages/utils/src/get-directives.ts:83

getDirectiveNodes

▸ getDirectiveNodes(entity, schema, pathToDirectivesInExtensions?): DirectiveNode[]

Parameters

Returns

DirectiveNode[]

Defined in

packages/utils/src/print-schema-with-directives.ts:229

getDirectives

▸ getDirectives(schema, node, pathToDirectivesInExtensions?): DirectiveAnnotation[]

Parameters

Returns

DirectiveAnnotation[]

Defined in

packages/utils/src/get-directives.ts:121

getDirectivesInExtensions

▸ getDirectivesInExtensions(node, pathToDirectivesInExtensions?): DirectiveAnnotation[]

Parameters

Returns

DirectiveAnnotation[]

Defined in

packages/utils/src/get-directives.ts:59

getDocumentNodeFromSchema

▸ getDocumentNodeFromSchema(schema, options?): DocumentNode

Parameters

Returns

DocumentNode

Defined in

packages/utils/src/print-schema-with-directives.ts:62

getFieldEntryKey

▸ getFieldEntryKey(node): string

Implements the logic to compute the key of a given field's entry

Parameters

Returns

string

Defined in

packages/utils/src/collectFields.ts:220

getFieldsWithDirectives

▸ getFieldsWithDirectives(documentNode, options?): TypeAndFieldToDirectives

Parameters

Returns

TypeAndFieldToDirectives

Defined in

packages/utils/src/get-fields-with-directives.ts:25

getImplementingTypes

▸ getImplementingTypes(interfaceName, schema): string[]

Parameters

Returns

string[]

Defined in