Skip to main content

@graphql-mesh/types

Interfaces#

Type aliases#

Functions#

Type aliases#

AllHooks#

Ƭ AllHooks: object

Type declaration:#

NameType
destroyvoid
resolverCalledobject
resolverCalled.resolverDataResolverData
resolverDoneobject
resolverDone.resolverDataResolverData
resolverDone.resultany
resolverErrorobject
resolverError.errorError
resolverError.resolverDataResolverData

Defined in: packages/types/src/index.ts:51


GetMeshSourceOptions#

Ƭ GetMeshSourceOptions<THandlerConfig, TIntrospectionCache\>: object

Type parameters:#

NameDefault
THandlerConfig-
TIntrospectionCachenever

Type declaration:#

NameType
baseDir?string
cacheKeyValueCache
configTHandlerConfig
introspectionCache?TIntrospectionCache
namestring
pubsubMeshPubSub

Defined in: packages/types/src/index.ts:24


GraphQLOperation#

Ƭ GraphQLOperation<TData, TVariables\>: TypedDocumentNode<TData, TVariables\> | string

Type parameters:#

Name
TData
TVariables

Defined in: packages/types/src/index.ts:114


HookName#

Ƭ HookName: keyof AllHooks & string

Defined in: packages/types/src/index.ts:58


ImportFn#

Ƭ ImportFn: (moduleId: string) => Promise<any\>

Type declaration:#

▸ (moduleId: string): Promise<any\>

Parameters:#

NameType
moduleIdstring

Returns: Promise<any\>

Defined in: packages/types/src/index.ts:116


Maybe#

Ƭ Maybe<T\>: null | undefined | T

Type parameters:#

Name
T

Defined in: packages/types/src/index.ts:87


MergerFn#

Ƭ MergerFn: (options: { cache: KeyValueCache ; executor?: Executor ; pubsub: MeshPubSub ; rawSources: RawSourceOutput[] ; resolvers?: IResolvers ; transforms?: Transform[] ; typeDefs?: DocumentNode[] }) => Promise<GraphQLSchema\> | GraphQLSchema

Type declaration:#

▸ (options: { cache: KeyValueCache ; executor?: Executor ; pubsub: MeshPubSub ; rawSources: RawSourceOutput[] ; resolvers?: IResolvers ; transforms?: Transform[] ; typeDefs?: DocumentNode[] }): Promise<GraphQLSchema\> | GraphQLSchema

Parameters:#

NameType
optionsobject
options.cacheKeyValueCache
options.executor?Executor
options.pubsubMeshPubSub
options.rawSourcesRawSourceOutput[]
options.resolvers?IResolvers
options.transforms?Transform[]
options.typeDefs?DocumentNode[]

Returns: Promise<GraphQLSchema\> | GraphQLSchema

Defined in: packages/types/src/index.ts:91


MeshSource#

Ƭ MeshSource<ContextType, InitialContext\>: object

Type parameters:#

NameDefault
ContextTypeany
InitialContextany

Type declaration:#

NameType
batch?boolean
contextBuilder?(initialContextValue: InitialContext) => Promise<ContextType\>
contextVariables?keyof InitialContext[]
executor?Executor
schemaGraphQLSchema
subscriber?Subscriber

Defined in: packages/types/src/index.ts:15


RawSourceOutput#

Ƭ RawSourceOutput: object

Type declaration:#

NameType
batchboolean
contextBuildernull | (initialContextValue?: any) => Promise<any\>
contextVariableskeyof any[]
executor?Executor
handlerMeshHandler
namestring
schemaGraphQLSchema
subscriber?Subscriber
transformsMeshTransform[]

Defined in: packages/types/src/index.ts:101


ResolverData#

Ƭ ResolverData<TParent, TArgs, TContext, TResult\>: object

Type parameters:#

NameDefault
TParentany
TArgsany
TContextany
TResultany

Type declaration:#

NameType
args?TArgs
context?TContext
info?GraphQLResolveInfo
result?TResult
root?TParent

Defined in: packages/types/src/index.ts:42

Functions#

getJsonSchema#

getJsonSchema(): any

Returns: any

Defined in: packages/types/src/index.ts:11