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

ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>

Type Parameters​

Type ParameterDefault type

Context

‐

Info

‐

TypesBuilders extends TypesBuildersMap<Context, Info>

any

TypesResolvers extends TypesResolversMap<Context, Info>

any

Constructors​

Constructor​

new ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>(options): ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>

Parameters​

ParameterType

options

ModuleBuilderOptions<Context, Info, TypesBuilders>

Returns​

ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>

Properties​

PropertyModifierType

requiredPluginIds

readonly

ReadonlySet<PluginId>

Accessors​

name​

Get Signature​

get name(): string

Returns​

string

Methods​

edit()​

edit(): object

Returns​

object

NameType

addMiddleware()

(middleware) => { readonly addMiddleware: (middleware: Middleware<unknown, unknown, Context, unknown, Info>) => any; readonly addTransformer: (transformer: SchemaTransformer | SchemaTransformer[]) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>; readonly commitToMethods: () => ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>; }

addRequiredPluginId()

(id) => { readonly addMiddleware: (middleware: Middleware<unknown, unknown, Context, unknown, Info>) => any; readonly addTransformer: (transformer: SchemaTransformer | SchemaTransformer[]) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>; readonly commitToMethods: () => ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>; }

addTransformer()

(transformer) => { readonly addMiddleware: (middleware: Middleware<unknown, unknown, Context, unknown, Info>) => any; readonly addTransformer: (transformer: SchemaTransformer | SchemaTransformer[]) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>; readonly commitToMethods: () => ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>; }

commit()

() => ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>

commitToMethods()

() => ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>

mergeMeta()

(meta) => { readonly addMiddleware: (middleware: Middleware<unknown, unknown, Context, unknown, Info>) => any; readonly addTransformer: (transformer: SchemaTransformer | SchemaTransformer[]) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => ModuleBuilder<Context, Info, TypesBuilders, TypesResolvers>; readonly commitToMethods: () => ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>; }


toMethods()​

toMethods(): ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>

Returns​

ModuleMethods<Context, Info, TypesBuilders, TypesResolvers>