> For the complete documentation index, see [llms.txt](https://superd001.gitbook.io/autorelay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://superd001.gitbook.io/autorelay/readme.md).
# AutoRelay
[](https://badge.fury.io/js/auto-relay) [](https://travis-ci.org/wemaintain/auto-relay)
AutoRelay is a librairy designed to work alongside [TypeGraphQL](https://typegraphql.ml/) and make it easy to paginate your results using the [Relay spec](https://facebook.github.io/relay/graphql/connections.htm).
## Motivation
At [WeMaintain](https://wemaintain.com) we're huge fans of [TypeGraphQL](https://typegraphql.ml/) and its code first approach to GraphQL. While implementing it in production, we quickly realized we wanted a systematic way to handle our pagination in a robust way. the Relay spec seemed perfect for our use cases and well supported in many client side libraries, but this meant creating a `Connection` and `Edge` type for each and every one of our entities.
Moreover, it meant copy/pasting a whole bunch of boilerplate to translate `ConnectionArgs` to inputs expected by an ORM, and some more for converting the results from the db to a relay `Collection` .
AutoRelay aims to make pagination using Relay easy and fast while still retaining customization and robustness.
As such, AutoRelay was designed with two goals in mind :
* Automate the pagination between two entities that share a relationship in TypeORM (more ORM support coming soon)
* Make it easy and boilerplate-free to implement your own pagination logic, by taking care of all the type generating and exposing easy to use APIs
{% hint style="danger" %}
Please note this is currently a W\.I.P, expect frequent breaking changes in the API until 1.0.0
{% endhint %}
```typescript
@Entity()
@ObjectType()
class User {
@OneToMany(() => Recipe)
@RelayedConnection(() => Recipe)
recipes: Recipe[];
}
```
This will result in the following working SDL:
```graphql
// Autogenrated by AutoRelay
type PageInfo {
hasNextPage: Boolean!
hasPreviousPage: Boolean!
startCursor: String!
endCursor: String!
}
// AutoGenerated by AutoRelay
type UserRecipeConnection {
edges: [UserRecipeEdge]!
pageInfo: PageInfo!
}
// AutoGenerated by AutoRelay
type UserRecipeEdge {
cursor: String!
node: Recipe!
}
type Recipe {
// ...
}
type User {
recipes(...): UserRecipeConnection
}
```
where `User.recipes` is now a fully working field resolver, that automatically takes Relay ConnectionArguments (*first, before, after, last*) and returns a Relay Connection containing the results.
## Installation
*This lib is meant to be used with TypeGraphQL. It will not work with other code-first graphql librairies*
1. Install the npm package:
`npm install auto-relay --save`
2. (Install an ORM *if you plan to use `@RelayedConnection`*)
*currently only TypeORM is supported*
`npm install @auto-relay/typeorm`
## Quick Start
Simply configure AutoRelay to use your ORM of choice, and you're ready to go !
*index.ts*
```typescript
import { TypeOrmConnection } from '@auto-relay/typeorm'
import { AutoRelayConfig } from 'auto-relay'
new AutoRelayConfig({ orm: () => TypeOrmConnection })
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://superd001.gitbook.io/autorelay/readme.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.