ISchemaBuilder | metanoia

Hierarchy

ISchemaBuilder

Implemented by

SchemaBuilder

Index

Methods

Methods

build

build(): GraphQLSchema

- Defined in builder.ts:139
Build the final executable schema from all the collected metadata.

Returns GraphQLSchema

decorateEnum

decorateEnum<T>(object: T, args: EnumDecorationArguments): void

- Defined in builder.ts:126
Declare a TypeScript enum to be a GraphQL enum.

Type parameters
- T
Parameters
- object: T
- args: EnumDecorationArguments
Returns void

description

description(text: string): PropertyDecorator

- Defined in builder.ts:42
Attach a description to a field.

Parameters
- text: string
Returns PropertyDecorator

field

field(type: OutputType | InputType, args?: FieldArguments): PropertyDecorator

- Defined in builder.ts:50
Declare a class property as a GraphQL field.

Parameters
- type: OutputType | InputType
- Optional args: FieldArguments
Returns PropertyDecorator

input

input(args?: InputArguments): ClassDecorator

- Defined in builder.ts:98
Declare a TypeScript class to be a GraphQL input.

Parameters
- Optional args: InputArguments
Returns ClassDecorator

interface

interface<R>(args?: InterfaceArguments<R>): ClassDecorator

- Defined in builder.ts:84
Declare a TypeScript class to be a GraphQL interface.

Type parameters
- R: GraphQLTypeResolver<any, any>
Parameters
- Optional args: InterfaceArguments<R>
Returns ClassDecorator

list

list(type: OutputType, args?: undefined | object): PropertyDecorator

- Defined in builder.ts:65
Declare a class property as a GraphQL list field.

Parameters
- type: OutputType
- Optional args: undefined | object
Returns PropertyDecorator

mutation

mutation(args: ResolverArguments): MethodDecorator

- Defined in builder.ts:112
Declare a static class method to be a mutation.

Parameters
- args: ResolverArguments
Returns MethodDecorator

nonNull

nonNull(): PropertyDecorator

- Defined in builder.ts:71
Declare a field to be non-null.

Returns PropertyDecorator

nonNullItems

nonNullItems(): PropertyDecorator

- Defined in builder.ts:77
Declare a list to have non-null items.

Returns PropertyDecorator

query

query(args: ResolverArguments): MethodDecorator

- Defined in builder.ts:105
Declare a static class method to be a query.

Parameters
- args: ResolverArguments
Returns MethodDecorator

resolve

resolve<R>(resolver: R): PropertyDecorator

- Defined in builder.ts:57
Attach a custom resolver to a GraphQL field.

Type parameters
- R: GraphQLFieldResolver<any, any>
Parameters
- resolver: R
Returns PropertyDecorator

scalar

scalar(args: ScalarArguments): ClassDecorator

- Defined in builder.ts:133
Declare a scalar type.

Parameters
- args: ScalarArguments
Returns ClassDecorator

subscription

subscription<R>(args: SubscriptionArguments<R>): MethodDecorator

- Defined in builder.ts:119
Declare a static class method to be a subscription.

Type parameters
- R: GraphQLFieldResolver<any, any>
Parameters
- args: SubscriptionArguments<R>
Returns MethodDecorator

type

type<R>(args?: TypeArguments<R>): ClassDecorator

- Defined in builder.ts:91
Declare a TypeScript class to be a GraphQL type.

Type parameters
- R: GraphQLIsTypeOfFn<any, any>
Parameters
- Optional args: TypeArguments<R>
Returns ClassDecorator

Generated using TypeDoc