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/types

Interfaces#

Type aliases#

Variables#

Type aliases#

AllHooks#

Ƭ AllHooks: Object

Index signature#

▪ [key: string]: any

Type declaration#

NameType
destroyvoid
executionDoneExecutionArgs & { executionResult: ExecutionResult }
resolverCalledObject
resolverCalled.resolverDataResolverData
resolverDoneObject
resolverDone.resolverDataResolverData
resolverDone.resultany
resolverErrorObject
resolverError.errorError
resolverError.resolverDataResolverData

Defined in#

packages/types/src/index.ts:60


GetMeshSourceOptions#

Ƭ GetMeshSourceOptions<THandlerConfig\>: Object

Type parameters#

Name
THandlerConfig

Type declaration#

NameType
baseDirstring
cacheKeyValueCache
configTHandlerConfig
importFnImportFn
loggerLogger
namestring
pubsubMeshPubSub
storeMeshStore

Defined in#

packages/types/src/index.ts:30


GraphQLOperation#

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

Type parameters#

Name
TData
TVariables

Defined in#

packages/types/src/index.ts:138


HookName#

Ƭ HookName: keyof AllHooks & string

Defined in#

packages/types/src/index.ts:68


ImportFn#

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

Type declaration#

▸ <T\>(moduleId): Promise<T\>

Type parameters#
NameType
TT = any
Parameters#
NameType
moduleIdstring
Returns#

Promise<T\>

Defined in#

packages/types/src/index.ts:140


InContextSdkMethod#

Ƭ InContextSdkMethod<TDefaultReturn, TArgs, TContext\>: <TKey, TReturn\>(params: { args?: TArgs ; context?: TContext ; info?: GraphQLResolveInfo ; key?: TKey ; root?: any ; selectionSet?: SelectionSetParamOrFactory ; argsFromKeys?: (keys: TKey[]) => TArgs ; valuesFromResults?: (results: TDefaultReturn, keys: TKey[]) => TReturn | TReturn[] }) => Promise<TReturn\>

Type parameters#

NameType
TDefaultReturnTDefaultReturn = any
TArgsTArgs = any
TContextTContext = any

Type declaration#

▸ <TKey, TReturn\>(params): Promise<TReturn\>

Type parameters#
NameType
TKeyTKey
TReturnTReturn = TDefaultReturn
Parameters#
NameType
paramsObject
params.args?TArgs
params.context?TContext
params.info?GraphQLResolveInfo
params.key?TKey
params.root?any
params.selectionSet?SelectionSetParamOrFactory
params.argsFromKeys?
params.valuesFromResults?
Returns#

Promise<TReturn\>

Defined in#

packages/types/src/index.ts:156


Logger#

Ƭ Logger: Object

Type declaration#

NameType
name?string
child(name: string) => Logger
debug(message: string) => void
error(message: string) => void
info(message: string) => void
log(message: string) => void
warn(message: string) => void

Defined in#

packages/types/src/index.ts:143


Maybe#

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

Type parameters#

Name
T

Defined in#

packages/types/src/index.ts:98


MeshSource#

Ƭ MeshSource<ContextType, InitialContext\>: Object

Type parameters#

NameType
ContextTypeContextType = any
InitialContextInitialContext = any

Type declaration#

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

Defined in#

packages/types/src/index.ts:22


RawSourceOutput#

Ƭ RawSourceOutput: Object

Type declaration#

NameType
batchboolean
contextBuildernull | (initialContextValue?: any) => Promise<any\>
contextVariableskeyof any[]
executor?Executor
handlerMeshHandler
merge?Record<string, MergedTypeConfig\>
namestring
schemaGraphQLSchema
transformsMeshTransform[]

Defined in#

packages/types/src/index.ts:125


ResolverData#

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

Type parameters#

NameType
TParentTParent = any
TArgsTArgs = any
TContextTContext = any
TResultTResult = any

Type declaration#

NameType
args?TArgs
context?TContext
envRecord<string, string\>
info?GraphQLResolveInfo
result?TResult
root?TParent

Defined in#

packages/types/src/index.ts:50


SelectionSetParam#

Ƭ SelectionSetParam: SelectionSetNode | DocumentNode | string | SelectionSetNode

Defined in#

packages/types/src/index.ts:153


SelectionSetParamOrFactory#

Ƭ SelectionSetParamOrFactory: (subtree: SelectionSetNode) => SelectionSetParam | SelectionSetParam

Defined in#

packages/types/src/index.ts:154


SyncImportFn#

Ƭ SyncImportFn: <T\>(moduleId: string) => T

Type declaration#

▸ <T\>(moduleId): T

Type parameters#
NameType
TT = any
Parameters#
NameType
moduleIdstring
Returns#

T

Defined in#

packages/types/src/index.ts:141

Variables#

jsonSchema#

Const jsonSchema: any

Defined in#

packages/types/src/index.ts:18