mongoose-relay-connection

Easiest and lightweight way to create a Relay Connection from Mongoose query for paginate thru.

Install

npm i mongoose-relay-connection --save

Use

Import connectionFromMongooseQuery function from package to file with your Relay Connection definition:

1import connectionFromMongooseQuery from 'mongoose-relay-connection'

Use it inside resolver of your connection (don't forget to await!):

1const PostsConnection = {
2  type: PostsConnectionType,
3  args: connectionArgs,
4  resolve: async (relayRoot, args) => {
5    const query = Post.find()
6    return await connectionFromMongooseQuery(query, args)
7  }
8}

Example

Full working example could look like so:

1import { GraphQLInt, GraphQLList } from 'graphql'
2import { connectionArgs, connectionDefinitions } from 'graphql-relay'
3import GraphQLPost from 'projectRoot/data/schema/types/GraphQLPost'
4import Post from 'projectRoot/data/models/Post'
5import connectionFromMongooseQuery from 'mongoose-relay-connection'
6
7const { connectionType: PostsConnectionType } = connectionDefinitions({
8  name: 'Posts',
9  nodeType: GraphQLPost,
10  connectionFields: () => ({
11    totalCount: {
12      type: GraphQLInt,
13      resolve: connection => connection.totalCount
14    },
15    posts: {
16      type: new GraphQLList(GraphQLPost),
17      resolve: connection => connection.edges.map(edge => edge.node)
18    }
19  })
20})
21
22const PostsConnection = {
23  type: PostsConnectionType,
24  args: connectionArgs,
25  resolve: async (relayRoot, args) => {
26    const query = Post.find() // Here you can add any filtering or sorting to your query
27    return await connectionFromMongooseQuery(query, args)
28  }
29}