Skip to content

Function: Mutation()

ts
function Mutation(typeFn?, options?): MethodDecorator;

Defined in: packages/apollo/src/decorators/mutation.decorator.ts:65

Decorator for a GraphQL Mutation.

Parameters

ParameterTypeDescription
typeFn?| string | (() => unknown) | MutationOptionsReturn type factory, options object, or mutation name.
options?MutationOptionsMutation options when typeFn is a function.

Returns

MethodDecorator

Example

typescript
@Mutation()
async createUser(@Args('input') input: CreateUserInput): Promise<User> {
  return this.userService.create(input);
}

@Mutation(() => User)
async create(@Args('input') input: CreateUserInput): Promise<User> {
  return this.userService.create(input);
}

@Mutation('updateUser')
async update(@Args('id') id: string, @Args('input') input: UpdateUserInput): Promise<User> {
  return this.userService.update(id, input);
}

@Mutation({ name: 'deleteUser', description: 'Delete user by id' })
async remove(@Args('id') id: string): Promise<boolean> {
  return this.userService.delete(id);
}

Released under the MIT License.