relay-page-info

Since 0.9.0 · In the rulesets: All at error, Relay at error

This rule checks that a schema with connections has a PageInfo type as the Relay Cursor Connections specification defines it.

Rule details

PageInfo is an object type with the fields hasNextPage: Boolean!, hasPreviousPage: Boolean!, and the nullable startCursor and endCursor of type String or a scalar.

The rule applies to definitions. An # apigenie-lint-disable relay-page-info 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.

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 PageInfo should have a field 'hasNextPage: Boolean!'.

type UserConnection { edges: [UserEdge], pageInfo: PageInfo! }
type PageInfo { hasNextPage: Boolean }

Turn it off or change its severity

In apigenie.yaml, off turns the rule off and warning or error sets its severity; a rule with options takes the severity and the options as a pair, [warning, options]. lint.graphql has the details.

commands:
  lint:
    graphql:
      rules:
        relay-page-info: off

Related rules

Further reading

Last updated on View as Markdown
Was this helpful?