# mongoose-relay-connection

> Easiest and lightweight way to create a relay connection from mongoose query for paginate over.

Latest version **1.0.3** (published 2019-05-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install mongoose-relay-connection
pnpm add mongoose-relay-connection
yarn add mongoose-relay-connection
bun add mongoose-relay-connection
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-05-26 |
| First published | 2019-05-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | famence |
| Maintainers | famence |
| Keywords | mongoose, relay, connection, pagination, graphql, mongodb, mongo |

## Links

- npm: https://www.npmjs.com/package/mongoose-relay-connection
- Repository: https://github.com/famence/mongoose-relay-connection
- Homepage: https://github.com/famence/mongoose-relay-connection#readme
- Issues: https://github.com/famence/mongoose-relay-connection/issues
- npm.io page: https://npm.io/package/mongoose-relay-connection

## Dependencies (1)

- [graphql-relay](https://npm.io/package/graphql-relay.md) ^0.6.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.0.3 (latest) — 2019-05-26
- 1.0.2 — 2019-05-26
- 1.0.1 — 2019-05-26
- 1.0.0 — 2019-05-26

## README

# 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:

```javascript
import connectionFromMongooseQuery from 'mongoose-relay-connection'
```

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

```javascript
const PostsConnection = {
  type: PostsConnectionType,
  args: connectionArgs,
  resolve: async (relayRoot, args) => {
    const query = Post.find()
    return await connectionFromMongooseQuery(query, args)
  }
}
```

## Example
Full working example could look like so:

```javascript
import { GraphQLInt, GraphQLList } from 'graphql'
import { connectionArgs, connectionDefinitions } from 'graphql-relay'
import GraphQLPost from 'projectRoot/data/schema/types/GraphQLPost'
import Post from 'projectRoot/data/models/Post'
import connectionFromMongooseQuery from 'mongoose-relay-connection'

const { connectionType: PostsConnectionType } = connectionDefinitions({
  name: 'Posts',
  nodeType: GraphQLPost,
  connectionFields: () => ({
    totalCount: {
      type: GraphQLInt,
      resolve: connection => connection.totalCount
    },
    posts: {
      type: new GraphQLList(GraphQLPost),
      resolve: connection => connection.edges.map(edge => edge.node)
    }
  })
})

const PostsConnection = {
  type: PostsConnectionType,
  args: connectionArgs,
  resolve: async (relayRoot, args) => {
    const query = Post.find() // Here you can add any filtering or sorting to your query
    return await connectionFromMongooseQuery(query, args)
  }
}
```

---
_Source: https://npm.io/package/mongoose-relay-connection · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._