Function: Query()

function Query(typeFn?, options?): MethodDecorator;

Defined in: packages/apollo/src/decorators/query.decorator.ts:60

Decorator for a GraphQL Query.

Parameters

Parameter	Type	Description
typeFn?	| string | (() => unknown) | QueryOptions	Return type factory, options object, or query name.
options?	QueryOptions	Query options when typeFn is a function.

Returns

MethodDecorator

Example

@Query()
async users(): Promise<User[]> {
  return this.userService.findAll();
}

@Query('user')
async findUser(@Args('id') id: string): Promise<User> {
  return this.userService.findById(id);
}

@Query({ name: 'user', description: 'Find user by id', nullable: true })
async findUser(@Args('id') id: string): Promise<User | null> {
  return this.userService.findById(id);
}