relay-cursor-paging

Relay Cursor-Based Pagination Support for Sequelize

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
relay-cursor-paging
15260.2.07 years ago8 years agoMinified + gzip package size for relay-cursor-paging in KB

Readme

Build Status
relay-cursor-paging

Relay Cursor-Based Pagination Support for Databases

API:

getPagingParameters(args): Emits an object with limit and criteria fields based on Relay's pagination fields (e.g. first, after, last, and before).
pageable(argSpec): Emits an augmented Argument Specification with first, after, before, and last arguments.
import { pageable, getPagingParameters } from "relay-cursor-paging";
const { connectionFromPromisedArraySlice } = require("graphql-relay");

const myType = new GraphQLObjectType({
    fields: () => {  
        relatedThings: {      
            type: thingConnection,
            args: pageable({}), // Adds first, after, last, and before arguments
            resolve: (root, args) => {
                const { limit, offset } = getPagingParameters(args);                
                const criteria = makeCriteria(args, limit, offset);
                                                            
                return connectionFromPromisedArraySlice(
                    thingRepository.findAll(criteria),
                    args, 
                    {
                        sliceStart: 0,
                        arrayLength: // count query result
                    }
                );
            }
        }
    }
});