NestJS Relay

A batteries-included toolkit for building Relay-compliant GraphQL APIs with NestJS v7.

Background

Relay is a Javascript client for GraphQL that is designed for performance and large-scale applications.

Relay provides powerful abstractions for building client applications, however, in order to understand the structure of an application's data, Relay requires that you follow certain conventions when defining your schema.

The three core assumptions that Relay makes about a GraphQL server are that it provides:

• A mechanism for refetching an object.
• A description of how to page through connections.
• Structure around mutations to make them predictable.

Features

• Build a Relay-compliant GraphQL API without the hassle!

Getting Started

Prerequisites

• NestJS GraphQL v7
• Code-first methodology

Installation

# NPM
npm i --save nestjs-relay

# GitHub Release
npm i --save github:rogerballard/nestjs-relay

Peer dependencies:

npm i --save graphql-relay graphql

Guides

• Refetching Data
• Mutations
• Connections

Documentation

• Full API

Further Reading

For further detail, please see the following resources.

Walkthroughs

• Relay's GraphQL Server Specification
• Global Object Identification

Specifications

• GraphQL Global Object Identification Specification
• GraphQL Cursor Connections Specification

Contributing

Please see the contribution guidelines and the code of conduct.