# graphql-compose-connection > Plugin for `graphql-compose` which provide a connection resolver for types. Latest version **8.2.1** (published 2021-07-09) · MIT license · 0 weekly downloads ## Install ```sh npm install graphql-compose-connection pnpm add graphql-compose-connection yarn add graphql-compose-connection bun add graphql-compose-connection ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 8.2.1 | | Published | 2021-07-09 | | First published | 2016-07-15 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 54.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 45 | | Maintainers | nodkz | | Keywords | graphql, compose, graphql-compose, relay | ## Links - npm: https://www.npmjs.com/package/graphql-compose-connection - Repository: https://github.com/graphql-compose/graphql-compose-connection - Issues: https://github.com/graphql-compose/graphql-compose-connection/issues - npm.io page: https://npm.io/package/graphql-compose-connection ## Alternatives - [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads - [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads - [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads - [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads - [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads ## Recent versions - 8.2.1 (latest) — 2021-07-09 - 8.1.1-alpha.1 (alpha) — 2021-05-18 - 8.2.0 — 2021-05-30 - 8.1.1 — 2021-05-25 - 8.1.0 — 2021-04-30 - 8.0.1 — 2020-09-14 - 8.0.0 — 2020-09-14 - 7.0.1 — 2020-08-17 - 7.0.0 — 2020-08-17 - 6.2.1 — 2020-05-30 - 6.2.0 — 2020-05-14 - 6.1.0 — 2020-05-05 - 6.0.4 — 2020-02-15 - 6.0.3 — 2019-06-04 - 6.0.2 — 2019-04-29 - … 47 more at https://npm.io/package/graphql-compose-connection/versions ## README # graphql-compose-connection [![travis build](https://img.shields.io/travis/graphql-compose/graphql-compose-connection.svg)](https://travis-ci.org/graphql-compose/graphql-compose-connection) [![codecov coverage](https://img.shields.io/codecov/c/github/graphql-compose/graphql-compose-connection.svg)](https://codecov.io/github/graphql-compose/graphql-compose-connection) [![version](https://img.shields.io/npm/v/graphql-compose-connection.svg)](https://www.npmjs.com/package/graphql-compose-connection) [![downloads](https://img.shields.io/npm/dt/graphql-compose-connection.svg)](http://www.npmtrends.com/graphql-compose-connection) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) This is a plugin for [graphql-compose](https://github.com/graphql-compose/graphql-compose) family, which adds to the ObjectTypeComposer `connection` resolver. Live demo: [https://graphql-compose.herokuapp.com/](https://graphql-compose.herokuapp.com/) This package completely follows to Relay Cursor Connections Specification (). Besides standard connection arguments `first`, `last`, `before` and `after`, also added significant arguments: - `filter` arg - for filtering records - `sort` arg - for sorting records. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields). [CHANGELOG](https://github.com/graphql-compose/graphql-compose-connection/blob/master/CHANGELOG.md) ## Installation ```bash npm install graphql graphql-compose graphql-compose-connection --save ``` Modules `graphql` and `graphql-compose` are in `peerDependencies`, so should be installed explicitly in your app. They should not installed as submodules, cause internally checks the classes instances. ## Example Implementation details of `findManyResolver` and `countResolver` can be found in [this file](./src/__mocks__/User.ts). ```js import { prepareConnectionResolver } from 'graphql-compose-connection'; import { UserTC, findManyResolver, countResolver } from './user'; prepareConnectionResolver(userTC, { findManyResolver, countResolver, sort: { // Sorting key, visible for users in GraphQL Schema _ID_ASC: { // Sorting value for ORM/Driver value: { _id: 1 }, // Field names in record, which data will be packed in `cursor` // edges { // cursor <- base64(cursorData), for this example `cursorData` = { _id: 334ae453 } // node <- record from DB // } // By this fields MUST be created UNIQUE index in database! cursorFields: ['_id'], // If for connection query provided `before` argument with above `cursor`. // We should construct (`rawQuery`) which will be point to dataset before cursor. // Unpacked data from `cursor` will be available in (`cursorData`) argument. // PS. All other filter options provided via GraphQL query will be added automatically. // ----- [record] ----- sorted dataset, according to above option with `value` name // ^^^^^ `rawQuery` should filter this set beforeCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery._id) rawQuery._id = {}; rawQuery._id.$lt = cursorData._id; }, // Constructing `rawQuery` for connection `after` argument. // ----- [record] ----- sorted dataset // ^^^^^ `rawQuery` should filter this set afterCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery._id) rawQuery._id = {}; rawQuery._id.$gt = cursorData._id; }, }, _ID_DESC: { value: { _id: -1 }, cursorFields: ['_id'], beforeCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery._id) rawQuery._id = {}; rawQuery._id.$gt = cursorData._id; }, afterCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery._id) rawQuery._id = {}; rawQuery._id.$lt = cursorData._id; }, }, // More complex sorting parameter with 2 fields AGE_ID_ASC: { value: { age: 1, _id: -1 }, // By these fields MUST be created COMPOUND UNIQUE index in database! cursorFields: ['age', '_id'], beforeCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery.age) rawQuery.age = {}; if (!rawQuery._id) rawQuery._id = {}; rawQuery.age.$lt = cursorData.age; rawQuery._id.$gt = cursorData._id; }, afterCursorQuery: (rawQuery, cursorData, resolveParams) => { if (!rawQuery.age) rawQuery.age = {}; if (!rawQuery._id) rawQuery._id = {}; rawQuery.age.$gt = cursorData.age; rawQuery._id.$lt = cursorData._id; }, } }, }); ``` screen shot 2016-07-20 at 12 20 08 ## Used in plugins [graphql-compose-mongoose](https://github.com/graphql-compose/graphql-compose-mongoose) - converts mongoose models to graphql types ## License [MIT](https://github.com/graphql-compose/graphql-compose-connection/blob/master/LICENSE.md) --- _Source: https://npm.io/package/graphql-compose-connection · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._