@graphql-tools/utils

References

• extractExtensionsFromSchema
• inspect
• withCancel

Enumerations

• DirectiveLocation
• MapperKind

Interfaces

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

Type Aliases

• ASTVisitorKeyMap
• AbstractTypeMapper
• ArgumentFilter
• ArgumentMapper
• ArgumentToDirectives
• AsyncExecutor
• BaseLoaderOptions
• Callback
• CompositeTypeMapper
• Constructor
• DirectableASTNode
• DirectableGraphQLObject
• DirectableObject
• DirectiveArgs
• DirectiveFilter
• DirectiveLocationEnum
• DirectiveMapper
• DirectiveUsage
• DisposableAsyncExecutor
• DisposableExecutor
• DisposableSyncExecutor
• ElementOf
• EnumTypeExtensions
• EnumTypeMapper
• EnumValueFilter
• 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
• createDeferred
• createGraphQLError
• createNamedStub
• createStub
• createVariableNameGenerator
• debugTimerEnd
• debugTimerStart
• dedentBlockStringValue
• doesFragmentConditionMatch
• fakePromise
• fakeRejectPromise
• filterSchema
• fixSchemaAst
• forEachDefaultValue
• forEachField
• getAbortPromise
• getArgumentValues
• getArgumentsWithDirectives
• getAsyncIterableWithCancel
• getAsyncIteratorWithCancel
• getBlockStringIndentation
• getBuiltInForStub
• getComment
• getDeferValues
• getDefinedRootType
• getDescription
• getDirective
• getDirectiveExtensions
• 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
• mapMaybePromise
• 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
• registerAbortSignalListener
• 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:474 

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

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

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

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

Constructor

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

Type parameters

Type declaration

• (...args): T

Parameters

Returns

T

Defined in

packages/utils/src/types.ts:31 

DirectableASTNode

Ƭ DirectableASTNode: ASTNode & { directives?: readonly DirectiveNode[] }

Defined in

packages/utils/src/getDirectiveExtensions.ts:6 

DirectableGraphQLObject

Ƭ DirectableGraphQLObject: DirectableObject

Defined in

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

DirectableObject

Ƭ DirectableObject: Object

Type declaration

Defined in

packages/utils/src/getDirectiveExtensions.ts:10 

DirectiveArgs

Ƭ DirectiveArgs: Object

Index signature

▪ [name: string]: any

Defined in

packages/utils/src/types.ts:151 

DirectiveFilter

Ƭ DirectiveFilter: (directiveName: string, directive: GraphQLDirective) => boolean

Type declaration

▸ (directiveName, directive): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:250 

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

DirectiveUsage

Ƭ DirectiveUsage: Object

Type declaration

Defined in

packages/utils/src/types.ts:152 

DisposableAsyncExecutor

Ƭ DisposableAsyncExecutor<TBaseContext, TBaseExtensions>: AsyncExecutor<TBaseContext, TBaseExtensions> & { [asyncDispose]: () => PromiseLike<void> }

Type parameters

Defined in

packages/utils/src/executor.ts:46 

DisposableExecutor

Ƭ DisposableExecutor<TBaseContext, TBaseExtensions>: DisposableSyncExecutor<TBaseContext, TBaseExtensions> | DisposableAsyncExecutor<TBaseContext, TBaseExtensions>

Type parameters

Defined in

packages/utils/src/executor.ts:52 

DisposableSyncExecutor

Ƭ DisposableSyncExecutor<TBaseContext, TBaseExtensions>: SyncExecutor<TBaseContext, TBaseExtensions> & { [dispose]: () => void }

Type parameters

Defined in

packages/utils/src/executor.ts:42 

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

EnumValueFilter

Ƭ EnumValueFilter: (typeName: string, valueName: string, valueConfig: GraphQLEnumValueConfig) => boolean

Type declaration

▸ (typeName, valueName, valueConfig): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:252 

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

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

FieldMapper

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

Defined in

packages/utils/src/Interfaces.ts:501 

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

FieldNodeMappers

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

Defined in

packages/utils/src/Interfaces.ts:215 

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

IDefaultValueIteratorFn

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

Type declaration

▸ (type, value): void

Parameters

Returns

void

Defined in

packages/utils/src/Interfaces.ts:351 

IEnumTypeResolver

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

Defined in

packages/utils/src/Interfaces.ts:188 

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

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

IInputObjectTypeResolver

Ƭ IInputObjectTypeResolver: Object

Type declaration

Defined in

packages/utils/src/Interfaces.ts:314 

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

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

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

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

ISchemaLevelResolver

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

Type parameters

Defined in

packages/utils/src/Interfaces.ts:322 

IUnionTypeResolver

Ƭ IUnionTypeResolver: Object

Type declaration

Defined in

packages/utils/src/Interfaces.ts:305 

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

InputFieldMapper

Ƭ InputFieldMapper: GenericFieldMapper<GraphQLInputFieldConfig>

Defined in

packages/utils/src/Interfaces.ts:510 

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

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

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

NextResolverFn

Ƭ NextResolverFn: () => Promise<any>

Type declaration

▸ (): Promise<any>

Returns

Promise<any>

Defined in

packages/utils/src/Interfaces.ts:353 

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

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

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

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

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

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

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

TypeSource

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

Defined in

packages/utils/src/Interfaces.ts:270 

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

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

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

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

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

astFromArg

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

Parameters

Returns

InputValueDefinitionNode

Defined in

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

astFromDirective

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

Parameters

Returns

DirectiveDefinitionNode

Defined in

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

astFromEnumType

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

Parameters

Returns

EnumTypeDefinitionNode

Defined in

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

astFromEnumValue

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