# relay-connection-types

Source: https://api-genie.dev/docs/linter/graphql/rules/relay-connection-types

A rule of the GraphQL linter, which reads GraphQL schemas and operations. Since 0.9.0. In the rulesets: All at error, Relay at error.

This rule checks that connection types follow the Relay Cursor Connections specification.

## Rule details

Types named `*Connection` are object types with an `edges` field returning a list of edge types and a `pageInfo: PageInfo!` field. Object types that have both fields are named `*Connection`.

The rule applies to definitions. An `# apigenie-lint-disable relay-connection-types` comment on a
node turns it off for the node and everything nested in it; at the top of the file, separated from
the first definition by a blank line, the comment turns it off for the whole file.

## Examples

**Good**.

```graphql
type Query {
  users(first: Int, after: String, last: Int, before: String): UserConnection
}
interface Node { id: ID! }
type User implements Node { id: ID! }
type UserConnection { edges: [UserEdge], pageInfo: PageInfo! }
type UserEdge { node: User, cursor: String! }
type PageInfo {
  hasNextPage: Boolean!
  hasPreviousPage: Boolean!
  startCursor: String
  endCursor: String
}
```

**Bad**. The linter reports `Connection type 'UserConnection' should have an 'edges' field returning a list of edges`.

```graphql
type UserConnection { users: [User] }
```
