Skip to main content
Version: Next (2.x)

ModuleCompiler<Context, Info, TypesResolvers>

Type Parameters​

Type ParameterDefault type

Context

unknown

Info

unknown

TypesResolvers extends TypesResolversMap<Context, Info>

TypesResolversMap<Context, Info>

Constructors​

Constructor​

new ModuleCompiler<Context, Info, TypesResolvers>(options): ModuleCompiler<Context, Info, TypesResolvers>

Parameters​

ParameterType

options

ModuleCompilerOptions<Context, Info, TypesResolvers>

Returns​

ModuleCompiler<Context, Info, TypesResolvers>

Properties​

PropertyModifierTypeDefault value

kind

readonly

"Module"

'Module'

Accessors​

name​

Get Signature​

get name(): string

Returns​

string


types​

Get Signature​

get types(): readonly TypeCompiler<unknown, Context, Info, FieldsResolversMap<unknown, Context, Info>>[]

Returns​

readonly TypeCompiler<unknown, Context, Info, FieldsResolversMap<unknown, Context, Info>>[]

Methods​

addMiddleware()​

addMiddleware(middleware): void

Parameters​

ParameterType

middleware

Middleware<unknown, unknown, Context, unknown, Info>

Returns​

void


build()​

build(): object

Returns​

object

NameTypeDefault value

requiredPluginIds

Set<PluginId>

allRequiredPluginIds

resolvers

IResolvers

‐

transformers

SchemaTransformer[]

‐

typedef

Readonly<DocumentNode>

‐


useMetadata()​

useMetadata<T>(key): object

Type Parameters​

Type Parameter

T

Parameters​

ParameterType

key

symbol

Returns​

object

NameType

get()

() => T | undefined

set()

(value) => Map<symbol, unknown>