@graphql-tools/utils

Table of contents

References

• extractExtensionsFromSchema
• withCancel

Enumerations

• DirectiveLocation
• MapperKind

Interfaces

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

Type Aliases

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

Variables

• GraphQLDeferDirective
• GraphQLStreamDirective

Functions

• addPath
• addTypes
• appendObjectFields
• asArray
• assertSome
• astFromArg
• astFromDirective
• astFromEnumType
• astFromEnumValue
• astFromField
• astFromInputField
• astFromInputObjectType
• astFromInterfaceType
• astFromObjectType
• astFromScalarType
• astFromSchema
• astFromUnionType
• astFromValueUntyped
• buildOperationNodeForField
• collectComment
• collectFields
• collectSubFields
• compareNodes
• compareStrings
• correctASTNodes
• createDefaultRules
• createGraphQLError
• createNamedStub
• createStub
• createVariableNameGenerator
• dedentBlockStringValue
• doesFragmentConditionMatch
• filterSchema
• fixSchemaAst
• forEachDefaultValue
• forEachField
• getArgumentValues
• getArgumentsWithDirectives
• getAsyncIterableWithCancel
• getAsyncIteratorWithCancel
• getBlockStringIndentation
• getBuiltInForStub
• getComment
• getDeferValues
• getDefinedRootType
• getDeprecatableDirectiveNodes
• getDescription
• getDirective
• getDirectiveInExtensions
• getDirectiveNodes
• getDirectives
• getDirectivesInExtensions
• getDocumentNodeFromSchema
• getFieldEntryKey
• getFieldsWithDirectives
• getImplementingTypes
• getLeadingCommentBlock
• getOperationASTFromDocument
• getOperationASTFromRequest
• getResolversFromSchema
• getResponseKeyFromInfo
• getRootTypeMap
• getRootTypeNames
• getRootTypes
• hasOwnProperty
• healSchema
• healTypes
• implementsAbstractType
• inspect
• isAsyncIterable
• isDescribable
• isDocumentNode
• isDocumentString
• isIterableObject
• isNamedStub
• isObjectLike
• isPromise
• isSome
• isValidPath
• makeDeprecatedDirective
• makeDirectiveNode
• makeDirectiveNodes
• mapAsyncIterator
• mapSchema
• memoize1
• memoize2
• memoize2of4
• memoize2of5
• memoize3
• memoize4
• memoize5
• mergeDeep
• 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

withCancel

Renames and re-exports getAsyncIterableWithCancel

Type Aliases

ASTVisitorKeyMap

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

Defined in

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

AbstractTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

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

ArgumentFilter

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

Type declaration

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

Parameters

Returns

boolean

Defined in

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

ArgumentMapper

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

Type declaration

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

Parameters

Returns

GraphQLArgumentConfig | [string, GraphQLArgumentConfig] | null | undefined

Defined in

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

ArgumentToDirectives

Ƭ ArgumentToDirectives: Object

Index signature

▪ [argumentName: string]: DirectiveUsage[]

Defined in

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

AsyncExecutor

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

Type parameters

Type declaration

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

Type parameters

Parameters

Returns

Promise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Defined in

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

BaseLoaderOptions

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

Defined in

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

Callback

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

Type declaration

▸ (value?): any

Parameters

Returns

any

Defined in

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

CompositeTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLObjectType | GraphQLInterfaceType | GraphQLUnionType | null | undefined

Defined in

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

Constructor

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

Type parameters

Type declaration

• (...args)

Parameters

Defined in

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

DirectiveArgs

Ƭ DirectiveArgs: Object

Index signature

▪ [name: string]: any

Defined in

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

DirectiveLocationEnum

Ƭ DirectiveLocationEnum: typeof DirectiveLocation

Defined in

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

DirectiveMapper

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

Type declaration

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

Parameters

Returns

GraphQLDirective | null | undefined

Defined in

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

DirectiveUsage

Ƭ DirectiveUsage: Object

Type declaration

Defined in

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

ElementOf

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

Type parameters

Defined in

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

EnumTypeExtensions

Ƭ EnumTypeExtensions: Object

Type declaration

Defined in

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

EnumTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLEnumType | null | undefined

Defined in

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

EnumValueMapper

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

Type declaration

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

Parameters

Returns

GraphQLEnumValueConfig | [string, GraphQLEnumValueConfig] | null | undefined

Defined in

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

ErrorVisitor

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

Type declaration

▸ (error, pathIndex): GraphQLError

Parameters

Returns

GraphQLError

Defined in

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

ErrorVisitorMap

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

Defined in

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

Executor

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

Type parameters

Type declaration

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

Type parameters

Parameters

Returns

MaybePromise<MaybeAsyncIterable<ExecutionResult<TReturn>>>

Defined in

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

ExtensionsObject

Ƭ ExtensionsObject: Record<string, any>

Defined in

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

FieldFilter

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

Type declaration

▸ (typeName, fieldName, fieldConfig): boolean

Parameters

Returns

boolean

Defined in

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

FieldMapper

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

Defined in

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

FieldNodeMapper

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

Type declaration

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

Parameters

Returns

SelectionNode | SelectionNode[]

Defined in

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

FieldNodeMappers

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

Defined in

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

Force

Ƭ Force: string[]

Defined in

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

GenericFieldMapper

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

Type parameters

Type declaration

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

Parameters

Returns

F | [string, F] | null | undefined

Defined in

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

IDefaultValueIteratorFn

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

Type declaration

▸ (type, value): void

Parameters

Returns

void

Defined in

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

IEnumTypeResolver

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

Defined in

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

IFieldIteratorFn

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

Type declaration

▸ (fieldDef, typeName, fieldName): void

Parameters

Returns

void

Defined in

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

IFieldResolver

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

Type parameters

Type declaration

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

Parameters

Returns

TReturn

Defined in

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

IInputObjectTypeResolver

Ƭ IInputObjectTypeResolver: Object

Type declaration

Defined in

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

IInterfaceTypeResolver

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

Type parameters

Defined in

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

IObjectTypeResolver

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

Type parameters

Defined in

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

IResolvers

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

Type parameters

Defined in

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

IScalarTypeResolver

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

Defined in

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

ISchemaLevelResolver

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

Type parameters

Defined in

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

IUnionTypeResolver

Ƭ IUnionTypeResolver: Object

Type declaration

Defined in

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

Ignore

Ƭ Ignore: string[]

Defined in

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

InputFieldFilter

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

Type declaration

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

Parameters

Returns

boolean

Defined in

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

InputFieldMapper

Ƭ InputFieldMapper: GenericFieldMapper<GraphQLInputFieldConfig>

Defined in

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

InputLeafValueTransformer

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

Type declaration

▸ (type, originalValue): any

Parameters

Returns

any

Defined in

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

InputObjectTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLInputObjectType | null | undefined

Defined in

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

InputObjectValueTransformer

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

Type declaration

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

Parameters

Returns

Record<string, any>

Defined in

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

InputTypeExtensions

Ƭ InputTypeExtensions: Object

Type declaration

Defined in

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

InterfaceTypeExtensions

Ƭ InterfaceTypeExtensions: Object

Type declaration

Defined in

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

InterfaceTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLInterfaceType | null | undefined

Defined in

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

Maybe

Ƭ Maybe<T>: null | undefined | T

Type parameters

Defined in

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

MaybeAsyncIterable

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

Type parameters

Defined in

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

MaybePromise

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

Type parameters

Defined in

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

NamedDefinitionNode

Ƭ NamedDefinitionNode: DefinitionNode & { name?: NameNode }

Defined in

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

NamedTypeMapper

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

Type declaration

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

Parameters

Returns

GraphQLNamedType | null | undefined

Defined in

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

NextResolverFn

Ƭ NextResolverFn: () => Promise<any>

Type declaration

▸ (): Promise<any>

Returns

Promise<any>

Defined in

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

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 (opens in a new tab)

ObjectTypeExtensions

Ƭ ObjectTypeExtensions: Object

Type declaration

Defined in

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

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:429 (opens in a new tab)

ObjectValueVisitor

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

Defined in

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

PossibleTypeExtensions

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

Defined in

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

PrintSchemaWithDirectivesOptions

Ƭ PrintSchemaWithDirectivesOptions: SchemaPrintOptions & GetDocumentNodeFromSchemaOptions

Defined in

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

PruneSchemaFilter

Ƭ PruneSchemaFilter: (type: GraphQLNamedType) => boolean

Type declaration

▸ (type): boolean

Parameters

Returns

boolean

Defined in

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

RenameTypesOptions

Ƭ RenameTypesOptions: Object

Type declaration

Defined in

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

ResultVisitorMap

Ƭ ResultVisitorMap: Record<string, ValueVisitor | ObjectValueVisitor>

Defined in

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

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 (opens in a new tab)

ScalarTypeExtensions

Ƭ ScalarTypeExtensions: Object

Type declaration

Defined in

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

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:413 (opens in a new tab)

SchemaExtensions

Ƭ SchemaExtensions: Object

Type declaration

Defined in

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

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:399 (opens in a new tab)

SelectedFields

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

Defined in

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

Skip

Ƭ Skip: string[]

Defined in

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

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:16 (opens in a new tab)

TypeAndFieldToArgumentDirectives

Ƭ TypeAndFieldToArgumentDirectives: Object

Index signature

▪ [typeAndField: string]: ArgumentToDirectives

Defined in

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

TypeAndFieldToDirectives

Ƭ TypeAndFieldToDirectives: Object

Index signature

▪ [typeAndField: string]: DirectiveUsage[]

Defined in

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

TypeFilter

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

Type declaration

▸ (typeName, type): boolean

Parameters

Returns

boolean

Defined in

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

TypeSource

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

Defined in

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

UnionTypeExtensions

Ƭ UnionTypeExtensions: Object

Type declaration

Defined in

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

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:441 (opens in a new tab)

ValidationRule

Ƭ ValidationRule: (context: ValidationContext) => ASTVisitor

Type declaration

▸ (context): ASTVisitor

Parameters

Returns

ASTVisitor

Defined in

packages/utils/src/validate-documents.ts:13 (opens in a new tab)

ValidatorBehavior

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

Defined in

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

ValueVisitor

Ƭ ValueVisitor: (value: any) => any

Type declaration

▸ (value): any

Parameters

Returns

any

Defined in

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

VisitableSchemaType

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

Defined in

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

WithList

Ƭ WithList<T>: T | T[]

Type parameters

Defined in

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

Variables

GraphQLDeferDirective

• Const GraphQLDeferDirective: GraphQLDirective

Used to conditionally defer fragments.

Defined in

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

GraphQLStreamDirective

• Const GraphQLStreamDirective: GraphQLDirective

Used to conditionally stream list fields.

Defined in

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

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 (opens in a new tab)

addTypes

▸ addTypes(schema, newTypesOrDirectives): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/addTypes.ts:34 (opens in a new tab)

appendObjectFields

▸ appendObjectFields(schema, typeName, additionalFields): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

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

asArray

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

Type parameters

Parameters

Returns

T[]

Defined in

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

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 (opens in a new tab)

astFromArg

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

Parameters

Returns

InputValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:296 (opens in a new tab)

astFromDirective

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

Parameters

Returns

DirectiveDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:197 (opens in a new tab)

astFromEnumType

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

Parameters

Returns

EnumTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:437 (opens in a new tab)

astFromEnumValue

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

Parameters

Returns

EnumValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:556 (opens in a new tab)

astFromField

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

Parameters

Returns

FieldDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:502 (opens in a new tab)

astFromInputField

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

Parameters

Returns

InputValueDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:529 (opens in a new tab)

astFromInputObjectType

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

Parameters

Returns

InputObjectTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:409 (opens in a new tab)

astFromInterfaceType

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

Parameters

Returns

InterfaceTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:350 (opens in a new tab)

astFromObjectType

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

Parameters

Returns

ObjectTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:324 (opens in a new tab)

astFromScalarType

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

Parameters

Returns

ScalarTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:463 (opens in a new tab)

astFromSchema

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

Parameters

Returns

SchemaDefinitionNode | SchemaExtensionNode | null

Defined in

packages/utils/src/print-schema-with-directives.ts:121 (opens in a new tab)

astFromUnionType

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

Parameters

Returns

UnionTypeDefinitionNode

Defined in

packages/utils/src/print-schema-with-directives.ts:383 (opens in a new tab)

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 (opens in a new tab)

buildOperationNodeForField

▸ buildOperationNodeForField(«destructured»): OperationDefinitionNode

Parameters

Returns

OperationDefinitionNode

Defined in

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

collectComment

▸ collectComment(node): void

Parameters

Returns

void

Defined in

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

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 (opens in a new tab)

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:248 (opens in a new tab)

compareNodes

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

Parameters

Returns

number

Defined in

packages/utils/src/helpers.ts:60 (opens in a new tab)

compareStrings

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

Type parameters

Parameters

Returns

1 | -1 | 0

Defined in

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

correctASTNodes

▸ correctASTNodes(type): GraphQLObjectType

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/mapSchema.ts:508 (opens in a new tab)

▸ correctASTNodes(type): GraphQLInterfaceType

Parameters

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/mapSchema.ts:509 (opens in a new tab)

▸ correctASTNodes(type): GraphQLInputObjectType

Parameters

Returns

GraphQLInputObjectType

Defined in

packages/utils/src/mapSchema.ts:510 (opens in a new tab)

▸ correctASTNodes(type): GraphQLEnumType

Parameters

Returns

GraphQLEnumType

Defined in

packages/utils/src/mapSchema.ts:511 (opens in a new tab)

createDefaultRules

▸ createDefaultRules(): ValidationRule[]

Returns

ValidationRule[]

Defined in

packages/utils/src/validate-documents.ts:46 (opens in a new tab)

createGraphQLError

▸ createGraphQLError(message, options?): GraphQLError

Parameters

Returns

GraphQLError

Defined in

packages/utils/src/errors.ts:17 (opens in a new tab)

createNamedStub

▸ createNamedStub(name, type): GraphQLObjectType

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/stub.ts:20 (opens in a new tab)

▸ createNamedStub(name, type): GraphQLInterfaceType

Parameters

Returns

GraphQLInterfaceType

Defined in

packages/utils/src/stub.ts:21 (opens in a new tab)

▸ createNamedStub(name, type): GraphQLInputObjectType

Parameters

Returns

GraphQLInputObjectType

Defined in

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

createStub

▸ createStub(node, type): GraphQLOutputType

Parameters

Returns

GraphQLOutputType

Defined in

packages/utils/src/stub.ts:46 (opens in a new tab)

▸ createStub(node, type): GraphQLInputType

Parameters

Returns

GraphQLInputType

Defined in

packages/utils/src/stub.ts:47 (opens in a new tab)

▸ createStub(node, type): GraphQLType

Parameters

Returns

GraphQLType

Defined in

packages/utils/src/stub.ts:48 (opens in a new tab)

createVariableNameGenerator

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

Parameters

Returns

fn

▸ (argName): string

Parameters

Returns

string

Defined in

packages/utils/src/updateArgument.ts:54 (opens in a new tab)

dedentBlockStringValue

▸ dedentBlockStringValue(rawString): string

Parameters

Returns

string

Defined in

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

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:188 (opens in a new tab)

filterSchema

▸ filterSchema(«destructured»): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/filterSchema.ts:17 (opens in a new tab)

fixSchemaAst

▸ fixSchemaAst(schema, options): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/fixSchemaAst.ts:12 (opens in a new tab)

forEachDefaultValue

▸ forEachDefaultValue(schema, fn): void

Parameters

Returns

void

Defined in

packages/utils/src/forEachDefaultValue.ts:5 (opens in a new tab)

forEachField

▸ forEachField(schema, fn): void

Parameters

Returns

void

Defined in

packages/utils/src/forEachField.ts:5 (opens in a new tab)

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:25 (opens in a new tab)

getArgumentsWithDirectives

▸ getArgumentsWithDirectives(documentNode): TypeAndFieldToArgumentDirectives

Parameters

Returns

TypeAndFieldToArgumentDirectives

Defined in

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

getAsyncIterableWithCancel

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

Type parameters

Parameters

Returns

TAsyncIterable

Defined in

packages/utils/src/withCancel.ts:43 (opens in a new tab)

getAsyncIteratorWithCancel

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

Type parameters

Parameters

Returns

AsyncIterator<T>

Defined in

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

getBlockStringIndentation

▸ getBlockStringIndentation(lines): number

Parameters

Returns

number

Defined in

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

getBuiltInForStub

▸ getBuiltInForStub(type): GraphQLNamedType

Parameters

Returns

GraphQLNamedType

Defined in

packages/utils/src/stub.ts:76 (opens in a new tab)

getComment

▸ getComment(node): undefined | string

Parameters

Returns

undefined | string

Defined in

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

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:220 (opens in a new tab)

getDefinedRootType

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

Parameters

Returns

GraphQLObjectType

Defined in

packages/utils/src/rootTypes.ts:5 (opens in a new tab)

getDeprecatableDirectiveNodes

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

Parameters

Returns

DirectiveNode[]

Defined in

packages/utils/src/print-schema-with-directives.ts:258 (opens in a new tab)

getDescription

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

Parameters

Returns

string | undefined

Defined in

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

getDirective

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

Parameters

Returns

Record<string, any>[] | undefined

Defined in

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

getDirectiveInExtensions

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

Parameters

Returns

Record<string, any>[] | undefined

Defined in

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

getDirectiveNodes

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

Parameters

Returns

DirectiveNode[]

Defined in

packages/utils/src/print-schema-with-directives.ts:226 (opens in a new tab)

getDirectives

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

Parameters

Returns

DirectiveAnnotation[]

Defined in

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

getDirectivesInExtensions

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

Parameters

Returns

DirectiveAnnotation[]

Defined in

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

getDocumentNodeFromSchema

▸ getDocumentNodeFromSchema(schema, options?): DocumentNode

Parameters

Returns

DocumentNode

Defined in

packages/utils/src/print-schema-with-directives.ts:59 (opens in a new tab)

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:211 (opens in a new tab)

getFieldsWithDirectives

▸ getFieldsWithDirectives(documentNode, options?): TypeAndFieldToDirectives

Parameters

Returns

TypeAndFieldToDirectives

Defined in

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

getImplementingTypes

▸ getImplementingTypes(interfaceName, schema): string[]

Parameters

Returns

string[]

Defined in

packages/utils/src/get-implementing-types.ts:3 (opens in a new tab)

getLeadingCommentBlock

▸ getLeadingCommentBlock(node): void | string

Parameters

Returns

void | string

Defined in

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

getOperationASTFromDocument

▸ getOperationASTFromDocument(documentNode, operationName?): OperationDefinitionNode

Parameters

Returns

OperationDefinitionNode

Defined in

packages/utils/src/getOperationASTFromRequest.ts:5 (opens in a new tab)

getOperationASTFromRequest

▸ getOperationASTFromRequest(request): OperationDefinitionNode

Parameters

Returns

OperationDefinitionNode

Defined in

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

getResolversFromSchema

▸ getResolversFromSchema(schema, includeDefaultMergedResolver?): IResolvers

Parameters

Returns

IResolvers

Defined in

packages/utils/src/getResolversFromSchema.ts:14 (opens in a new tab)

getResponseKeyFromInfo

▸ getResponseKeyFromInfo(info): string

Get the key under which the result of this resolver will be placed in the response JSON. Basically, just resolves aliases.

Parameters

Returns

string

Defined in

packages/utils/src/getResponseKeyFromInfo.ts:8 (opens in a new tab)

getRootTypeMap

▸ getRootTypeMap(schema): Map<OperationTypeNode, GraphQLObjectType<any, any>>

Parameters

Returns

Map<OperationTypeNode, GraphQLObjectType<any, any>>

Defined in

packages/utils/src/rootTypes.ts:31 (opens in a new tab)

getRootTypeNames

▸ getRootTypeNames(schema): Set<string>

Parameters

Returns

Set<string>

Defined in

packages/utils/src/rootTypes.ts:21 (opens in a new tab)

getRootTypes

▸ getRootTypes(schema): Set<GraphQLObjectType<any, any>>

Parameters

Returns

Set<GraphQLObjectType<any, any>>

Defined in

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

hasOwnProperty

▸ hasOwnProperty(obj, prop): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/jsutils.ts:31 (opens in a new tab)

healSchema

▸ healSchema(schema): GraphQLSchema

Parameters

Returns

GraphQLSchema

Defined in

packages/utils/src/heal.ts:52 (opens in a new tab)

healTypes

▸ healTypes(originalTypeMap, directives): void

Parameters

Returns

void

Defined in

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

implementsAbstractType

▸ implementsAbstractType(schema, typeA, typeB): boolean

Parameters

Returns

boolean

Defined in

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

inspect

▸ inspect(value): string

Used to print values in error messages.

Parameters

Returns

string

Defined in

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

isAsyncIterable

▸ isAsyncIterable<T>(value): value is AsyncIterable<T>

Type parameters

Parameters

Returns

value is AsyncIterable<T>

Defined in

packages/utils/src/isAsyncIterable.ts:1 (opens in a new tab)

isDescribable

▸ isDescribable(node): node is DescribableASTNodes

Parameters

Returns

node is DescribableASTNodes

Defined in

packages/utils/src/parse-graphql-sdl.ts:97 (opens in a new tab)

isDocumentNode

▸ isDocumentNode(object): object is DocumentNode

Parameters

Returns

object is DocumentNode

Defined in

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

isDocumentString

▸ isDocumentString(str): boolean

Parameters

Returns

boolean

Defined in

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

isIterableObject

▸ isIterableObject(value): value is Iterable<unknown>

Parameters

Returns

value is Iterable<unknown>

Defined in

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

isNamedStub

▸ isNamedStub(type): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/stub.ts:63 (opens in a new tab)

isObjectLike

▸ isObjectLike(value): value is Object

Parameters

Returns

value is Object

Defined in

packages/utils/src/jsutils.ts:7 (opens in a new tab)

isPromise

▸ isPromise<T>(value): value is PromiseLike<T>

Type parameters

Parameters

Returns

value is PromiseLike<T>

Defined in

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

isSome

▸ isSome<T>(input): input is Exclude<T, undefined | null>

Type parameters

Parameters

Returns

input is Exclude<T, undefined | null>

Defined in

packages/utils/src/helpers.ts:71 (opens in a new tab)

isValidPath

▸ isValidPath(str): boolean

Parameters

Returns

boolean

Defined in

packages/utils/src/helpers.ts:29 (opens in a new tab)

makeDeprecatedDirective

▸ makeDeprecatedDirective(deprecationReason): DirectiveNode

Parameters

Returns

DirectiveNode

Defined in

packages/utils/src/print-schema-with-directives.ts:581 (opens in a new tab)

makeDirectiveNode

▸ makeDirectiveNode(name, args, directive?): DirectiveNode

Parameters

Returns

DirectiveNode

Defined in

packages/utils/src/print-schema-with-directives.ts:585 (opens in a new tab)

makeDirectiveNodes

▸ makeDirectiveNodes(schema, directiveValues): DirectiveNode[]

Parameters

Returns

DirectiveNode[]

Defined in

packages/utils/src/print-schema-with-directives.ts:637 (opens in a new tab)

mapAsyncIterator

▸ mapAsyncIterator<T, U>(iterator, callback, rejectCallback?): AsyncIterableIterator<U>

Given an AsyncIterable and a callback function, return an AsyncIterator which produces values mapped via calling the callback function.

Type parameters