SubscriptionBuilder<Result, Source, Context, Args, Info>

Type Parameters

Type Parameter
Result
Source
Context
Args
Info

Constructors

Constructor

new SubscriptionBuilder<Result, Source, Context, Args, Info>(options): SubscriptionBuilder<Result, Source, Context, Args, Info>

Parameters

Parameter	Type
options	SubscriptionBuilderOptions<Result, Source, Context, Args, Info>

Returns

SubscriptionBuilder<Result, Source, Context, Args, Info>

Properties

Property	Modifier	Type
requiredPluginIds	readonly	ReadonlySet<PluginId>

Accessors

field

Get Signature

get field(): string

Returns

string

Methods

edit()

edit(): object

Returns

object

Name	Type
addMiddleware()	(middleware) => { readonly field: string; readonly addMiddleware: (middleware: Middleware<Subscription<unknown>, Source, Context, Args, Info>) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => SubscriptionBuilder<Result, Source, Context, Args, Info>; readonly commitToMethods: <P = never>() => SubscriptionMethods<Result, Source, Context, Args, Info, P>; }
addRequiredPluginId()	(id) => { readonly field: string; readonly addMiddleware: (middleware: Middleware<Subscription<unknown>, Source, Context, Args, Info>) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => SubscriptionBuilder<Result, Source, Context, Args, Info>; readonly commitToMethods: <P = never>() => SubscriptionMethods<Result, Source, Context, Args, Info, P>; }
commit()	() => SubscriptionBuilder<Result, Source, Context, Args, Info>
commitToMethods()	<P>() => SubscriptionMethods<Result, Source, Context, Args, Info, P>
field	string
mergeMeta()	(meta) => { readonly field: string; readonly addMiddleware: (middleware: Middleware<Subscription<unknown>, Source, Context, Args, Info>) => any; readonly addRequiredPluginId: (id: PluginId) => any; readonly mergeMeta: (meta: Map<symbol, unknown>) => any; readonly commit: () => SubscriptionBuilder<Result, Source, Context, Args, Info>; readonly commitToMethods: <P = never>() => SubscriptionMethods<Result, Source, Context, Args, Info, P>; }

---

toMethods()

toMethods<Payload>(): SubscriptionMethods<Result, Source, Context, Args, Info, Payload>

Type Parameters

Type Parameter	Default type
Payload	never

Returns

SubscriptionMethods<Result, Source, Context, Args, Info, Payload>