The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

@graphql-mesh/runtime

Type aliases#

Functions#

Type aliases#

APIContext#

Ƭ APIContext: Object

Type declaration#

NameType
MutationRecord<string, fn\>
QueryRecord<string, fn\>
SubscriptionRecord<string, fn\>
rawSourceRawSourceOutput

Defined in#

packages/runtime/src/types.ts:62


APIContextMethodParams#

Ƭ APIContextMethodParams: Object

Type declaration#

NameType
args?any
contextany
info?GraphQLResolveInfo
root?any
selectionSet?string

Defined in#

packages/runtime/src/types.ts:54


ExecuteMeshFn#

Ƭ ExecuteMeshFn<TData, TVariables, TContext, TRootValue\>: (document: GraphQLOperation<TData, TVariables\>, variables: TVariables, context?: TContext, rootValue?: TRootValue, operationName?: string) => Promise<TData | null | undefined\>

Type parameters#

NameType
TDataTData = any
TVariablesTVariables = any
TContextTContext = any
TRootValueTRootValue = any

Type declaration#

▸ (document, variables, context?, rootValue?, operationName?): Promise<TData | null | undefined\>

Parameters#
NameType
documentGraphQLOperation<TData, TVariables\>
variablesTVariables
context?TContext
rootValue?TRootValue
operationName?string
Returns#

Promise<TData | null | undefined\>

Defined in#

packages/runtime/src/types.ts:36


GetMeshOptions#

Ƭ GetMeshOptions: Object

Type declaration#

NameType
additionalResolvers?IResolvers | IResolvers[]
additionalTypeDefs?DocumentNode[]
cacheKeyValueCache
liveQueryInvalidations?LiveQueryInvalidation[]
logger?Logger
mergerMeshMerger
pubsubMeshPubSub
sourcesMeshResolvedSource[]
transforms?MeshTransform[]

Defined in#

packages/runtime/src/types.ts:17


MeshContext#

Ƭ MeshContext: { [key: string]: APIContext; [MESH_CONTEXT_SYMBOL]: true } & { cache: KeyValueCache ; pubsub: MeshPubSub }

Defined in#

packages/runtime/src/types.ts:69


MeshResolvedSource#

Ƭ MeshResolvedSource<TContext\>: Object

Type parameters#

NameType
TContextTContext = any

Type declaration#

NameType
handlerMeshHandler<TContext\>
merge?Record<string, MergedTypeConfig\>
namestring
transforms?MeshTransform[]

Defined in#

packages/runtime/src/types.ts:29


Requester#

Ƭ Requester<C\>: <R, V\>(doc: DocumentNode, vars?: V, options?: C) => Promise<R\>

Type parameters#

NameType
CC = any

Type declaration#

▸ <R, V\>(doc, vars?, options?): Promise<R\>

Type parameters#
Name
R
V
Parameters#
NameType
docDocumentNode
vars?V
options?C
Returns#

Promise<R\>

Defined in#

packages/runtime/src/types.ts:52


SubscribeMeshFn#

Ƭ SubscribeMeshFn<TVariables, TContext, TRootValue, TData\>: (document: GraphQLOperation<TData, TVariables\>, variables?: TVariables, context?: TContext, rootValue?: TRootValue, operationName?: string) => Promise<TData | null | undefined | AsyncIterableIterator<TData | null | undefined\>\>

Type parameters#

NameType
TVariablesTVariables = any
TContextTContext = any
TRootValueTRootValue = any
TDataTData = any

Type declaration#

▸ (document, variables?, context?, rootValue?, operationName?): Promise<TData | null | undefined | AsyncIterableIterator<TData | null | undefined\>\>

Parameters#
NameType
documentGraphQLOperation<TData, TVariables\>
variables?TVariables
context?TContext
rootValue?TRootValue
operationName?string
Returns#

Promise<TData | null | undefined | AsyncIterableIterator<TData | null | undefined\>\>

Defined in#

packages/runtime/src/types.ts:44

Functions#

applyResolversHooksToResolvers#

applyResolversHooksToResolvers(resolvers, pubsub, meshContext): IResolvers

Parameters#

NameType
resolversIResolvers
pubsubMeshPubSub
meshContextany

Returns#

IResolvers

Defined in#

packages/runtime/src/resolvers-hooks.ts:9


applyResolversHooksToSchema#

applyResolversHooksToSchema(schema, pubsub, meshContext): GraphQLSchema

Parameters#

NameType
schemaGraphQLSchema
pubsubMeshPubSub
meshContextany

Returns#

GraphQLSchema

Defined in#

packages/runtime/src/resolvers-hooks.ts:63


getMesh#

getMesh(options): Promise<MeshInstance\>

Parameters#

NameType
optionsGetMeshOptions

Returns#

Promise<MeshInstance\>

Defined in#

packages/runtime/src/get-mesh.ts:63