graphql-compose-connection
This is a plugin for graphql-compose family, which adds to the TypeComposer connection
resolver.
Live demo: https://graphql-compose.herokuapp.com/
This package completely follows to Relay Cursor Connections Specification (https://facebook.github.io/relay/graphql/connections.htm).
Besides standard connection arguments first
, last
, before
and after
, also added significant arguments:
filter
arg - for filtering recordssort
arg - for sorting records. Build in mechanism allows sort by any unique indexes (not only by id). Also supported compound sorting (by several fields).
Installation
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
;; ;
Requirements
Types should have following resolvers:
count
- for counting recordsfindMany
- for filtering records. Also required that this resolver supports search with operators (lt, gt), which used indirectionFilter
option. ResolverfindMany
should havefilter
argument, which will be copied to connection. Also should havelimit
andskip
args.
Used in plugins
graphql-compose-mongoose - converts mongoose models to graphql types