Documentation
API Reference
Packages
utils

@graphql-tools/utils

References

Enumerations

Interfaces

Type Aliases

Variables

Functions

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
NameType
typeGraphQLInterfaceType | GraphQLUnionType
schemaGraphQLSchema
Returns

GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:469


ArgumentFilter

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

Type declaration

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

Parameters
NameType
typeName?string
fieldName?string
argName?string
argConfig?GraphQLArgumentConfig
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
NameType
argumentConfigGraphQLArgumentConfig
fieldNamestring
typeNamestring
schemaGraphQLSchema
Returns

GraphQLArgumentConfig | [string, GraphQLArgumentConfig] | null | undefined

Defined in

packages/utils/src/Interfaces.ts:498


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

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Type declaration

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

Type parameters
NameType
TReturnany
TArgsextends Record<string, any> = Record<string, any>
TContextextends TBaseContext = TBaseContext
TRootany
TExtensionsextends TBaseExtensions = TBaseExtensions
Parameters
NameType
requestExecutionRequest<TArgs, TContext, TRoot, TExtensions, TReturn>
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
NameType
value?any
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
NameType
typeGraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType
schemaGraphQLSchema
Returns

GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:454


Constructor

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

Type parameters

Name
T

Type declaration

• (...args): T

Parameters
NameType
...argsany[]
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


DirectiveFilter

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

Type declaration

▸ (directiveName, directive): boolean

Parameters
NameType
directiveNamestring
directiveGraphQLDirective
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:245


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
NameType
directiveGraphQLDirective
schemaGraphQLSchema
Returns

GraphQLDirective | null | undefined

Defined in

packages/utils/src/Interfaces.ts:484


DirectiveUsage

Ƭ DirectiveUsage: Object

Type declaration

NameType
argsDirectiveArgs
namestring

Defined in

packages/utils/src/types.ts:152


DisposableAsyncExecutor

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

Type parameters

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Defined in

packages/utils/src/executor.ts:46


DisposableExecutor

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

Type parameters

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Defined in

packages/utils/src/executor.ts:52


DisposableSyncExecutor

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

Type parameters

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Defined in

packages/utils/src/executor.ts:42


ElementOf

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

Type parameters

Name
TList

Defined in

packages/utils/src/loaders.ts:19


EnumTypeExtensions

Ƭ EnumTypeExtensions: Object

Type declaration

NameType
type"enum"
valuesRecord<string, ExtensionsObject>

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
NameType
typeGraphQLEnumType
schemaGraphQLSchema
Returns

GraphQLEnumType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:442


EnumValueFilter

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

Type declaration

▸ (typeName, valueName, valueConfig): boolean

Parameters
NameType
typeNamestring
valueNamestring
valueConfigGraphQLEnumValueConfig
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:247


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
NameType
valueConfigGraphQLEnumValueConfig
typeNamestring
schemaGraphQLSchema
externalValuestring
Returns

GraphQLEnumValueConfig | [string, GraphQLEnumValueConfig] | null | undefined

Defined in

packages/utils/src/Interfaces.ts:447


ErrorVisitor

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

Type declaration

▸ (error, pathIndex): GraphQLError

Parameters
NameType
errorGraphQLError
pathIndexnumber
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

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Type declaration

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

Type parameters
NameType
TReturnany
TArgsextends Record<string, any> = Record<string, any>
TContextextends TBaseContext = TBaseContext
TRootany
TExtensionsextends TBaseExtensions = TBaseExtensions
Parameters
NameType
requestExecutionRequest<TArgs, TContext, TRoot, TExtensions, TReturn>
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
NameType
typeNamestring
fieldNamestring
fieldConfigGraphQLFieldConfig<any, any> | GraphQLInputFieldConfig
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:218


FieldMapper

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

Defined in

packages/utils/src/Interfaces.ts:496


FieldNodeMapper

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

Type declaration

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

Parameters
NameType
fieldNodeFieldNode
fragmentsRecord<string, FragmentDefinitionNode>
transformationContextRecord<string, any>
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

NameType
Fextends GraphQLFieldConfig<any, any> | GraphQLInputFieldConfig

Type declaration

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

Parameters
NameType
fieldConfigF
fieldNamestring
typeNamestring
schemaGraphQLSchema
Returns

F | [string, F] | null | undefined

Defined in

packages/utils/src/Interfaces.ts:489


IDefaultValueIteratorFn

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

Type declaration

▸ (type, value): void

Parameters
NameType
typeGraphQLInputType
valueany
Returns

void

Defined in

packages/utils/src/Interfaces.ts:346


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
NameType
fieldDefGraphQLField<any, any>
typeNamestring
fieldNamestring
Returns

void

Defined in

packages/utils/src/Interfaces.ts:340


IFieldResolver

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

Type parameters

NameType
TSourceTSource
TContextTContext
TArgsRecord<string, any>
TReturnany

Type declaration

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

Parameters
NameType
sourceTSource
argsTArgs
contextTContext
infoGraphQLResolveInfo
Returns

TReturn

Defined in

packages/utils/src/Interfaces.ts:258


IInputObjectTypeResolver

Ƭ IInputObjectTypeResolver: Object

Type declaration

NameType
__astNode?InputObjectTypeDefinitionNode
__description?string
__extensionASTNodes?InputObjectTypeExtensionNode[]
__extensions?Record<string, any>
__name?string

Defined in

packages/utils/src/Interfaces.ts:309


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

NameType
TSourceany
TContextany
TArgsany

Defined in

packages/utils/src/Interfaces.ts:287


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

NameType
TSourceany
TContextany
TArgsany

Defined in

packages/utils/src/Interfaces.ts:274


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

NameType
TSourceany
TContextany
TArgsRecord<string, any>
TReturnany

Defined in

packages/utils/src/Interfaces.ts:324


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

NameType
TSourceTSource
TContextTContext
TArgsRecord<string, any>
TReturnany

Defined in

packages/utils/src/Interfaces.ts:317


IUnionTypeResolver

Ƭ IUnionTypeResolver: Object

Type declaration

NameType
__astNode?UnionTypeDefinitionNode
__description?string
__extensionASTNodes?UnionTypeExtensionNode[]
__extensions?Record<string, any>
__name?string
__resolveType?GraphQLTypeResolver<any, any>

Defined in

packages/utils/src/Interfaces.ts:300


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
NameType
typeName?string
fieldName?string
inputFieldConfig?GraphQLInputFieldConfig
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:212


InputFieldMapper

Ƭ InputFieldMapper: GenericFieldMapper<GraphQLInputFieldConfig>

Defined in

packages/utils/src/Interfaces.ts:505


InputLeafValueTransformer

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

Type declaration

▸ (type, originalValue): any

Parameters
NameType
typeGraphQLEnumType | GraphQLScalarType
originalValueany
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
NameType
typeGraphQLInputObjectType
schemaGraphQLSchema
Returns

GraphQLInputObjectType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:464


InputObjectValueTransformer

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

Type declaration

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

Parameters
NameType
typeGraphQLInputObjectType
originalValueRecord<string, any>
Returns

Record<string, any>

Defined in

packages/utils/src/types.ts:68


InputTypeExtensions

Ƭ InputTypeExtensions: Object

Type declaration

NameType
fieldsRecord<string, { extensions: ExtensionsObject }>
type"input"

Defined in

packages/utils/src/types.ts:112


InterfaceTypeExtensions

Ƭ InterfaceTypeExtensions: Object

Type declaration

NameType
fieldsRecord<string, { arguments: Record<string, ExtensionsObject> ; extensions: ExtensionsObject }>
type"interface"

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
NameType
typeGraphQLInterfaceType
schemaGraphQLSchema
Returns

GraphQLInterfaceType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:479


Maybe

Ƭ Maybe<T>: null | undefined | T

Type parameters

Name
T

Defined in

packages/utils/src/types.ts:29


MaybeAsyncIterable

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

Type parameters

Name
T

Defined in

packages/utils/src/executor.ts:4


MaybePromise

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

Type parameters

Name
T

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
NameType
typeGraphQLNamedType
schemaGraphQLSchema
Returns

GraphQLNamedType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:432


NextResolverFn

Ƭ NextResolverFn: () => Promise<any>

Type declaration

▸ (): Promise<any>

Returns

Promise<any>

Defined in

packages/utils/src/Interfaces.ts:348


ObjectFieldFilter

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

Type declaration

▸ (typeName, fieldName, fieldConfig): boolean

Parameters
NameType
typeNamestring
fieldNamestring
fieldConfigGraphQLFieldConfig<any, any>
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:224


ObjectTypeExtensions

Ƭ ObjectTypeExtensions: Object

Type declaration

NameType
fieldsRecord<string, { arguments: Record<string, ExtensionsObject> ; extensions: ExtensionsObject }>
type"object"

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
NameType
typeGraphQLObjectType
schemaGraphQLSchema
Returns

GraphQLObjectType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:459


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
NameType
typeGraphQLNamedType
Returns

boolean

Defined in

packages/utils/src/types.ts:33


RenameTypesOptions

Ƭ RenameTypesOptions: Object

Type declaration

NameType
renameBuiltinsboolean
renameScalarsboolean

Defined in

packages/utils/src/Interfaces.ts:253


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
NameType
operation"Query" | "Mutation" | "Subscription"
rootFieldNamestring
fieldConfigGraphQLFieldConfig<any, any>
Returns

boolean

Defined in

packages/utils/src/Interfaces.ts:230


ScalarTypeExtensions

Ƭ ScalarTypeExtensions: Object

Type declaration

NameType
type"scalar"

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
NameType
typeGraphQLScalarType
schemaGraphQLSchema
Returns

GraphQLScalarType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:437


SchemaExtensions

Ƭ SchemaExtensions: Object

Type declaration

NameType
schemaExtensionsExtensionsObject
typesRecord<string, { extensions: ExtensionsObject } & PossibleTypeExtensions>

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


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

NameType
TBaseContextRecord<string, any>
TBaseExtensionsRecord<string, any>

Type declaration

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

Type parameters
NameType
TReturnany
TArgsextends Record<string, any> = Record<string, any>
TContextextends TBaseContext = TBaseContext
TRootany
TExtensionsextends TBaseExtensions = TBaseExtensions
Parameters
NameType
requestExecutionRequest<TArgs, TContext, TRoot, TExtensions, TReturn>
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
NameType
typeNamestring
typeGraphQLType
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:265


UnionTypeExtensions

Ƭ UnionTypeExtensions: Object

Type declaration

NameType
type"union"

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
NameType
typeGraphQLUnionType
schemaGraphQLSchema
Returns

GraphQLUnionType | null | undefined

Defined in

packages/utils/src/Interfaces.ts:474


ValidationRule

Ƭ ValidationRule: (context: ValidationContext) => ASTVisitor

Type declaration

▸ (context): ASTVisitor

Parameters
NameType
contextValidationContext
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
NameType
valueany
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:350


WithList

Ƭ WithList<T>: T | T[]

Type parameters

Name
T

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

NameType
prevundefined | Readonly<Path>
keystring | number
typenameundefined | string

Returns

Path

Defined in

packages/utils/src/Path.ts:12


addTypes

addTypes(schema, newTypesOrDirectives): GraphQLSchema

Parameters

NameType
schemaGraphQLSchema
newTypesOrDirectives(GraphQLDirective | GraphQLNamedType)[]

Returns

GraphQLSchema

Defined in

packages/utils/src/addTypes.ts:39


appendObjectFields

appendObjectFields(schema, typeName, additionalFields): GraphQLSchema

Parameters

NameType
schemaGraphQLSchema
typeNamestring
additionalFieldsGraphQLFieldConfigMap<any, any>

Returns

GraphQLSchema

Defined in

packages/utils/src/fields.ts:11


asArray

asArray<T>(fns): T[]

Type parameters

Name
T

Parameters

NameType
fnsT | T[]

Returns

T[]

Defined in

packages/utils/src/helpers.ts:3


assertSome

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

Type parameters

Name
T

Parameters

NameTypeDefault value
inputTundefined
messagestring'Value should be something'

Returns

asserts input is Exclude<T, undefined | null>

Defined in

packages/utils/src/helpers.ts:83


astFromArg

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

Parameters

NameType
argGraphQLArgument
schema?GraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

InputValueDefinitionNode

Defined in

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


astFromDirective

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

Parameters

NameType
directiveGraphQLDirective
schema?GraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

DirectiveDefinitionNode

Defined in

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


astFromEnumType

astFromEnumType(type, schema, pathToDirectivesInExtensions?): EnumTypeDefinitionNode

Parameters

NameType
typeGraphQLEnumType
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

EnumTypeDefinitionNode

Defined in

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


astFromEnumValue

astFromEnumValue(value, schema, pathToDirectivesInExtensions?): EnumValueDefinitionNode

Parameters

NameType
valueGraphQLEnumValue
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

EnumValueDefinitionNode

Defined in

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


astFromField

astFromField(field, schema, pathToDirectivesInExtensions?): FieldDefinitionNode

Parameters

NameType
fieldGraphQLField<any, any, any>
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

FieldDefinitionNode

Defined in

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


astFromInputField

astFromInputField(field, schema, pathToDirectivesInExtensions?): InputValueDefinitionNode

Parameters

NameType
fieldGraphQLInputField
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

InputValueDefinitionNode

Defined in

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


astFromInputObjectType

astFromInputObjectType(type, schema, pathToDirectivesInExtensions?): InputObjectTypeDefinitionNode

Parameters

NameType
typeGraphQLInputObjectType
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

InputObjectTypeDefinitionNode

Defined in

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


astFromInterfaceType

astFromInterfaceType(type, schema, pathToDirectivesInExtensions?): InterfaceTypeDefinitionNode

Parameters

NameType
typeGraphQLInterfaceType
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

InterfaceTypeDefinitionNode

Defined in

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


astFromObjectType

astFromObjectType(type, schema, pathToDirectivesInExtensions?): ObjectTypeDefinitionNode

Parameters

NameType
typeGraphQLObjectType<any, any>
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

ObjectTypeDefinitionNode

Defined in

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


astFromScalarType

astFromScalarType(type, schema, pathToDirectivesInExtensions?): ScalarTypeDefinitionNode

Parameters

NameType
typeGraphQLScalarType<unknown, unknown>
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

ScalarTypeDefinitionNode

Defined in

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


astFromSchema

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

Parameters

NameType
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

SchemaDefinitionNode | SchemaExtensionNode | null

Defined in

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


astFromUnionType

astFromUnionType(type, schema, pathToDirectivesInExtensions?): UnionTypeDefinitionNode

Parameters

NameType
typeGraphQLUnionType
schemaGraphQLSchema
pathToDirectivesInExtensions?string[]

Returns

UnionTypeDefinitionNode

Defined in

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


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.

JSON ValueGraphQL Value
ObjectInput Object
ArrayList
BooleanBoolean
StringString
NumberInt / Float
BigIntInt
nullNullValue

Parameters

NameType
valueany

Returns

ValueNode | null

Defined in

packages/utils/src/astFromValueUntyped.ts:19


buildOperationNodeForField

buildOperationNodeForField(«destructured»): OperationDefinitionNode

Parameters

NameTypeDefault value
«destructured»Objectundefined
› argNames?string[]undefined
› circularReferenceDepth?numberundefined
› depthLimit?numberundefined
› fieldstringundefined
› ignore?Ignore[]
› kindOperationTypeNodeundefined
› models?string[]undefined
› schemaGraphQLSchemaundefined
› selectedFields?SelectedFieldstrue

Returns

OperationDefinitionNode

Defined in

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


collectComment

collectComment(node): void

Parameters

NameType
nodeNamedDefinitionNode

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

NameType
TVariablesany

Parameters

NameType
schemaGraphQLSchema
fragmentsRecord<string, FragmentDefinitionNode>
variableValuesTVariables
runtimeTypeGraphQLObjectType<any, any>
selectionSetSelectionSetNode

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

NameType
schemaGraphQLSchema
fragmentsRecord<string, FragmentDefinitionNode>
variableValuesObject
returnTypeGraphQLObjectType<any, any>
fieldNodesFieldNode[]

Returns

FieldsAndPatches

Defined in

packages/utils/src/collectFields.ts:257


compareNodes

compareNodes(a, b, customFn?): number

Parameters

NameType
aASTNode
bASTNode
customFn?(a: any, b: any) => number

Returns

number

Defined in

packages/utils/src/helpers.ts:68


compareStrings

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

Type parameters

Name
A
B

Parameters

NameType
aA
bB

Returns

-1 | 0 | 1

Defined in

packages/utils/src/helpers.ts:41


correctASTNodes

correctASTNodes(type): GraphQLObjectType

Parameters

NameType
typeGraphQLObjectType<any, any>

Returns

GraphQLObjectType

Defined in

packages/utils/src/mapSchema.ts:539

correctASTNodes(type): GraphQLInterfaceType

Parameters

NameType
typeGraphQLInterfaceType

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/mapSchema.ts:540

correctASTNodes(type): GraphQLInputObjectType

Parameters

NameType
typeGraphQLInputObjectType

Returns

GraphQLInputObjectType

Defined in

packages/utils/src/mapSchema.ts:541

correctASTNodes(type): GraphQLEnumType

Parameters

NameType
typeGraphQLEnumType

Returns

GraphQLEnumType

Defined in

packages/utils/src/mapSchema.ts:542


createDefaultRules

createDefaultRules(): ValidationRule[]

Returns

ValidationRule[]

Defined in

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


createGraphQLError

createGraphQLError(message, options?): GraphQLError

Parameters

NameType
messagestring
options?GraphQLErrorOptions

Returns

GraphQLError

Defined in

packages/utils/src/errors.ts:38


createNamedStub

createNamedStub(name, type): GraphQLObjectType

Parameters

NameType
namestring
type"object"

Returns

GraphQLObjectType

Defined in

packages/utils/src/stub.ts:20

createNamedStub(name, type): GraphQLInterfaceType

Parameters

NameType
namestring
type"interface"

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/stub.ts:21

createNamedStub(name, type): GraphQLInputObjectType

Parameters

NameType
namestring
type"input"

Returns

GraphQLInputObjectType

Defined in

packages/utils/src/stub.ts:22


createStub

createStub(node, type): GraphQLOutputType

Parameters

NameType
nodeTypeNode
type"output"

Returns

GraphQLOutputType

Defined in

packages/utils/src/stub.ts:46

createStub(node, type): GraphQLInputType

Parameters

NameType
nodeTypeNode
type"input"

Returns

GraphQLInputType

Defined in

packages/utils/src/stub.ts:47

createStub(node, type): GraphQLType

Parameters

NameType
nodeTypeNode
type"input" | "output"

Returns

GraphQLType

Defined in

packages/utils/src/stub.ts:48


createVariableNameGenerator

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

Parameters

NameType
variableDefinitionMapRecord<string, VariableDefinitionNode>

Returns

fn

▸ (argName): string

Parameters
NameType
argNamestring
Returns

string

Defined in

packages/utils/src/updateArgument.ts:53


debugTimerEnd

debugTimerEnd(name): void

Parameters

NameType
namestring

Returns

void

Defined in

packages/utils/src/debugTimer.ts:11


debugTimerStart

debugTimerStart(name): void

Parameters

NameType
namestring

Returns

void

Defined in

packages/utils/src/debugTimer.ts:3


dedentBlockStringValue

dedentBlockStringValue(rawString): string

Parameters

NameType
rawStringstring

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

NameType
schemaGraphQLSchema
fragmentFragmentDefinitionNode | InlineFragmentNode
typeGraphQLObjectType<any, any>

Returns

boolean

Defined in

packages/utils/src/collectFields.ts:197


filterSchema

filterSchema(«destructured»): GraphQLSchema

Parameters

NameTypeDefault value
«destructured»Objectundefined
› argumentFilter?ArgumentFilterundefined
› directiveFilter?DirectiveFilterundefined
› enumValueFilter?EnumValueFilterundefined
› fieldFilter?FieldFilterundefined
› inputObjectFieldFilter?FieldFilterundefined
› interfaceFieldFilter?FieldFilterundefined
› objectFieldFilter?FieldFilterundefined
› rootFieldFilter?RootFieldFilterundefined
› schemaGraphQLSchemaundefined
› typeFilter?TypeFilterundefined

Returns

GraphQLSchema

Defined in

packages/utils/src/filterSchema.ts:22


fixSchemaAst

fixSchemaAst(schema, options): GraphQLSchema

Parameters

NameType
schemaGraphQLSchema
optionsBuildSchemaOptions & SchemaPrintOptions

Returns

GraphQLSchema

Defined in

packages/utils/src/fixSchemaAst.ts:12


forEachDefaultValue

forEachDefaultValue(schema, fn): void

Parameters

NameType
schemaGraphQLSchema
fnIDefaultValueIteratorFn

Returns

void

Defined in

packages/utils/src/forEachDefaultValue.ts:4


forEachField

forEachField(schema, fn): void

Parameters

NameType
schemaGraphQLSchema
fnIFieldIteratorFn

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

NameType
defGraphQLDirective | GraphQLField<any, any, any>
nodeFieldNode | DirectiveNode
variableValuesRecord<string, any>

Returns

Record<string, any>

Defined in

packages/utils/src/getArgumentValues.ts:24


getArgumentsWithDirectives

getArgumentsWithDirectives(documentNode): TypeAndFieldToArgumentDirectives

Parameters

NameType
documentNodeDocumentNode

Returns

TypeAndFieldToArgumentDirectives

Defined in

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


getAsyncIterableWithCancel

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

Type parameters

NameType
TT
TAsyncIterableextends AsyncIterable<T>
TReturnany

Parameters

NameType
asyncIterableTAsyncIterable
onCancel(value?: TReturn) => void | Promise<void>

Returns

TAsyncIterable

Defined in

packages/utils/src/withCancel.ts:43


getAsyncIteratorWithCancel

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

Type parameters

NameType
TT
TReturnany

Parameters

NameType
asyncIteratorAsyncIterator<T, any, undefined>
onCancel(value?: TReturn) => void | Promise<void>

Returns

AsyncIterator<T>

Defined in

packages/utils/src/withCancel.ts:16


getBlockStringIndentation

getBlockStringIndentation(lines): number

Parameters

NameType
linesreadonly string[]

Returns

number

Defined in

packages/utils/src/comments.ts:519


getBuiltInForStub

getBuiltInForStub(type): GraphQLNamedType

Parameters

NameType
typeGraphQLNamedType

Returns

GraphQLNamedType

Defined in

packages/utils/src/stub.ts:76


getComment

getComment(node): undefined | string

Parameters

NameType
nodeObject
node.loc?Location

Returns

undefined | string

Defined in

packages/utils/src/comments.ts:463


getDeferValues

getDeferValues(variableValues, node): undefined