avoid-scalar-result-type-on-mutation.md

avoid-scalar-result-type-on-mutation

• Category: Best Practices
• Rule name: @graphql-eslint/avoid-scalar-result-type-on-mutation
• Requires GraphQL Schema: true ℹ️
• Requires GraphQL Operations: false ℹ️

Avoid scalar result type on mutation type to make sure to return a valid state.

Usage Examples

Incorrect

# eslint @graphql-eslint/avoid-scalar-result-type-on-mutation: 'error'

type Mutation {
  createUser: Boolean
}

Correct

# eslint @graphql-eslint/avoid-scalar-result-type-on-mutation: 'error'

type Mutation {
  createUser: User!
}