Api Reference

@ObjectType

Registers a class as a GraphQL object type.

xxxxxxxxxx
 
interface ObjectTypeOptions {
  name?: string; // infered from class name
  description?: string;
}
​
@ObjectType(options?: ObjectTypeOptions)

@Field

Registers a class field as a GraphQLField.

xxxxxxxxxx
 
interface IFieldOptions {
  description?: string
  type?: any
  onlyDecoratedArgs?: boolean // when true this will not expose arguments that aren't decorated by @Arg()
  // useful when you have optional arguments that you only want to use on the backend
  name?: string
  nullable?: boolean
}
​
@Field(options?: FieldOptions)

@InputObjectType

xxxxxxxxxx
 
interface InputObjectTypeOptions {
  name?: string;
  description?: string;
}
​
@InputObjectType(options?: InputObjectTypeOptions)

@InputField

xxxxxxxxxx
 
 interface InputFieldOptions {
  description?: string;
  defaultValue?: any;
  type?: any | () => any;
  name?: string;
  nullable?: boolean;
}
​
@InputField(options?: InputFieldOptions)

@InputFieldNullable

xxxxxxxxxx
 
 interface InputFieldOptions {
  description?: string;
  defaultValue?: any;
  type?: any | () => any;
  name?: string;
}
​
@InputFieldNullable(options?: InputFieldOptions)

@DuplexObjectType

Just a shorthand-it is the same as putting both @InputObjectType and @ObjectType

xxxxxxxxxx
 
interface DuplexObjectTypeOptions {
  name?: string;
  description?: string;
}
​
@DuplexObjectType(options?: DuplexObjectTypeOptions)

@DuplexField

Just a shorthand-it is the same as putting both @InputField and @Field

xxxxxxxxxx
 
 interface DuplexFieldOptions {
  description?: string;
  defaultValue?: any;
  type?: any | () => any;
  name?: string;
  nullable?: boolean;
  inputNullable?: boolean;
}
​
@DuplexField(options?: DuplexFieldOptions)

@Arg

xxxxxxxxxx
 
 interface ArgOptions {
  description?: string;
  type?: any;
  nullable?: boolean;
}
@Arg(options?: ArgOptions)

@ArgNullable

xxxxxxxxxx
 
 interface ArgOptions {
  description?: string;
  type?: any;
}
@Arg(options?: ArgOptions)

@Inject

xxxxxxxxxx
 
type InjectorResolver = (
  source: any,
  args: any,
  context: any,
  info: GraphQLResolveInfo,
) => any;
​
@Inject(resolver: InjectorResolver): ParameterDecorator {

@Context

No decorator options avaliable

xxxxxxxxxx
 
@Context: ParameterDecorator

@Source

No decorator options avaliable

xxxxxxxxxx
 
@Source: ParameterDecorator

@Info

No decorator options avaliable

xxxxxxxxxx
 
@Info: ParameterDecorator

@Before

xxxxxxxxxx
 
interface HookExecutorResolverArgs {
  source: any;
  args: { [argName: string]: any };
  context: any;
  info: GraphQLResolveInfo;
}
​
type HookExecutor = (data: HookExecutorResolverArgs) => any | Promise<any>;
​
@Before(hook: HookExecutor);

@After

xxxxxxxxxx
 
interface HookExecutorResolverArgs {
  source: any;
  args: { [argName: string]: any };
  context: any;
  info: GraphQLResolveInfo;
}
​
type HookExecutor = (data: HookExecutorResolverArgs) => any | Promise<any>;
​
@After(hook: HookExecutor);

@SchemaRoot

xxxxxxxxxx
 
@SchemaRoot(): ClassDecorator;

@Query

Has same interface as @Field decorator. Can be used only inside @SchemaRoot class

@Mutation

Has same interface as @Field decorator. Can be used only inside @SchemaRoot class

@QueryAndMutation

A shorthand for both Query And Mutation. Can be used only inside @SchemaRoot class

@Union

xxxxxxxxxx
 
interface UnionOptions {
  name?: string;
  resolveTypes?: (value: any, context: any, info: GraphQLResolveInfo): any; // must return type resolvable to one of defined in `types` option
  types: any[] | () => any[];
}
​
interface UnionTypeResolver {
  (value: any, context: any, info: GraphQLResolveInfo): any;
}
​
@Union(options: UnionOptions): ClassDecorator;

registerEnum

xxxxxxxxxx
 
interface EnumOptions {
  name: string;
  description?: string;
}
​
registerEnum(enumDef: Object, options: EnumOptions | string): void;

compileSchema

xxxxxxxxxx
 
compileSchema(schemaTarget: Function): GraphQLSchema

compileObjectType,

xxxxxxxxxx
 
compileObjectType(schemaTarget: Function): GraphQLObjectType

compileInputObjectType,

xxxxxxxxxx
 
compileInputObjectType(schemaTarget: Function): GraphQLInputObjectType

Decapi

Api Reference

@ObjectType

@Field

@InputObjectType

@InputField

@InputFieldNullable

@DuplexObjectType

@DuplexField

@Arg

@ArgNullable

@Inject

@Context

@Source

@Info

@Before

@After

@SchemaRoot

@Query

@Mutation

@QueryAndMutation

@Union

registerEnum

compileSchema

compileObjectType,

compileInputObjectType,