@graphql-eslint/eslint-plugin/docs/rules/require-type-pattern-with-oneof.md

GraphQL plugin for ESLint

# `require-type-pattern-with-oneof`

- Category: `Schema`
- Rule name: `@graphql-eslint/require-type-pattern-with-oneof`
- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
- Requires GraphQL Operations: `false`
  [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)

Enforce types with `@oneOf` directive have `error` and `ok` fields.

## Usage Examples

### Correct

```graphql
# eslint @graphql-eslint/require-type-pattern-with-oneof: 'error'

type Mutation {
  doSomething: DoSomethingMutationResult!
}

interface Error {
  message: String!
}

type DoSomethingMutationResult @oneOf {
  ok: DoSomethingSuccess
  error: Error
}

type DoSomethingSuccess {
  # ...
}
```

## Resources

- [Rule source](../../packages/plugin/src/rules/require-type-pattern-with-oneof.ts)
- [Test source](../../packages/plugin/tests/require-type-pattern-with-oneof.spec.ts)