Docs
API
Modules
runtime_src

Table of contents

Interfaces

Type Aliases

Functions

Type Aliases

ExecuteMeshFn

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

Type parameters

NameType
TDataany
TVariablesany
TContextany
TRootValueany

Type declaration

▸ (document, variables, context?, rootValue?, operationName?): Promise<ExecutionResult<TData>>

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

Promise<ExecutionResult<TData>>

Defined in

packages/runtime/src/types.ts:38


GetMeshOptions

Ƭ GetMeshOptions: Object

Type declaration

NameType
additionalEnvelopPlugins?Parameters<typeof envelop>[0]["plugins"]
additionalResolvers?IResolvers | IResolvers[]
additionalTypeDefs?DocumentNode[]
cacheKeyValueCache
documents?Source[]
logger?Logger
mergerMeshMerger
pubsub?MeshPubSub
sourcesMeshResolvedSource[]
transforms?MeshTransform[]

Defined in

packages/runtime/src/types.ts:18


MeshContext

Ƭ MeshContext: { [MESH_CONTEXT_SYMBOL]: true } & { cache: KeyValueCache ; logger: Logger ; pubsub: MeshPubSub }

Defined in

packages/runtime/src/types.ts:54


MeshResolvedSource

Ƭ MeshResolvedSource: Object

Type declaration

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

Defined in

packages/runtime/src/types.ts:31


SubscribeMeshFn

Ƭ SubscribeMeshFn<TVariables, TContext, TRootValue, TData>: (document: GraphQLOperation<TData, TVariables>, variables?: TVariables, context?: TContext, rootValue?: TRootValue, operationName?: string) => Promise<ExecutionResult<TData> | AsyncIterable<ExecutionResult<TData>>>

Type parameters

NameType
TVariablesany
TContextany
TRootValueany
TDataany

Type declaration

▸ (document, variables?, context?, rootValue?, operationName?): Promise<ExecutionResult<TData> | AsyncIterable<ExecutionResult<TData>>>

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

Promise<ExecutionResult<TData> | AsyncIterable<ExecutionResult<TData>>>

Defined in

packages/runtime/src/types.ts:46

Functions

getMesh

getMesh(options): Promise<MeshInstance>

Parameters

NameType
optionsGetMeshOptions

Returns

Promise<MeshInstance>


useSubschema

useSubschema(subschema): Object

Parameters

NameType
subschemaSubschemaConfig<any, any, any, Record<string, any>>

Returns

Object

NameType
pluginPlugin
transformedSchemaGraphQLSchema