1. module express-paginate
   1. function express-paginate.getArrayPages (req)
   2. function express-paginate.hasNextPages (req)
   3. function express-paginate.href (req)
   4. function express-paginate.middleware (limit, maxLimit)

module express-paginate

function express-paginate.getArrayPages (req)

• description and source-code

  getArrayPages = function (req) {
    return function(limit, pageCount, currentPage) {
      var maxPage = pageCount;
  
      // limit default is 3
      limit = limit || 3;
  
      if (typeof limit !== 'number' || limit < 0)
        throw new Error('express-paginate: `limit` is not a number >= 0');
  
      if (typeof pageCount !== 'number' || pageCount < 0)
        throw new Error('express-paginate: `pageCount` is not a number >= 0');
  
      if (typeof currentPage !== 'number' || currentPage < 0)
        throw new Error('express-paginate: `currentPage` is not a number >= 0');
  
      if (limit > 0) {
        var end = Math.min(Math.max(currentPage + Math.floor(limit / 2), limit), pageCount);
        var start = (currentPage < (limit - 1)) ? 1 : (end - limit) + 1;
  			
        var pages = [];
        for (var i = start; i <= end; i++) {
          pages.push({
            number: i,
            url: exports.href(req)()
            .replace('page=' + (currentPage + 1), 'page=' + i)
          });
        }
  
        return pages;
      }
    }
  }

• example usage

  ...
  
      res.locals.paginate = {};
      res.locals.paginate.page = req.query.page;
      res.locals.paginate.limit = req.query.limit;
      res.locals.paginate.href = exports.href(req);
      res.locals.paginate.hasPreviousPages = req.query.page > 1;
      res.locals.paginate.hasNextPages = exports.hasNextPages(req);
      res.locals.paginate.getArrayPages = exports.getArrayPages(req);
  
      next();
  
    };
  
  };
  ...

function express-paginate.hasNextPages (req)

• description and source-code

  function hasNextPages(req) {
    return function(pageCount) {
      if (typeof pageCount !== 'number' || pageCount < 0)
        throw new Error('express-paginate: `pageCount` is not a number >= 0');
      return req.query.page < pageCount;
    };
  }

• example usage

  ...
      req.skip = req.offset = (req.query.page * req.query.limit) - req.query.limit;
  
      res.locals.paginate = {};
      res.locals.paginate.page = req.query.page;
      res.locals.paginate.limit = req.query.limit;
      res.locals.paginate.href = exports.href(req);
      res.locals.paginate.hasPreviousPages = req.query.page > 1;
      res.locals.paginate.hasNextPages = exports.hasNextPages(req);
      res.locals.paginate.getArrayPages = exports.getArrayPages(req);
  
      next();
  
    };
  
  };
  ...

function express-paginate.href (req)

• description and source-code

  function href(req) {
  
    return function(prev, params) {
  
      var query = clone(req.query);
  
      if (typeof prev === 'object') {
        params = prev;
        prev = false;
      } else {
        prev = (typeof prev === 'boolean') ? prev : false;
        query.page = prev ? query.page-= 1 : query.page += 1;
        query.page = (query.page < 1) ? 1 : query.page;
      }
  
      // allow overriding querystring params
      // (useful for sorting and filtering)
      // another alias for `_.assign` is `_.extend`
      if (isObject(params))
        query = assign(query, params);
  
      return url.parse(req.originalUrl).pathname + '?' + querystring.stringify(query);
  
    };
  }

• example usage

  ...
      var end = Math.min(Math.max(currentPage + Math.floor(limit / 2), limit), pageCount);
      var start = (currentPage < (limit - 1)) ? 1 : (end - limit) + 1;
  			
      var pages = [];
      for (var i = start; i <= end; i++) {
        pages.push({
          number: i,
          url: exports.href(req)()
          .replace('page=' + (currentPage + 1), 'page=' + i)
        });
      }
  
      return pages;
    }
  }
  ...

function express-paginate.middleware (limit, maxLimit)

• description and source-code

  function middleware(limit, maxLimit) {
  
    var _limit = (typeof limit === 'number') ? parseInt(limit, 10) : 10;
  
    var _maxLimit = (typeof maxLimit === 'number') ? parseInt(maxLimit, 10) : 50;
  
    return function _middleware(req, res, next) {
  
      req.query.page = (typeof req.query.page === 'string') ? parseInt(req.query.page, 10) || 1 : 1;
  
      req.query.limit = (typeof req.query.limit === 'string') ? parseInt(req.query.limit, 10) || 0 : _limit;
  
      if (req.query.limit > _maxLimit)
        req.query.limit = _maxLimit;
  
      if (req.query.page < 1)
        req.query.page = 1;
  
      if (req.query.limit < 0)
        req.query.limit = 0;
  
      req.skip = req.offset = (req.query.page * req.query.limit) - req.query.limit;
  
      res.locals.paginate = {};
      res.locals.paginate.page = req.query.page;
      res.locals.paginate.limit = req.query.limit;
      res.locals.paginate.href = exports.href(req);
      res.locals.paginate.hasPreviousPages = req.query.page > 1;
      res.locals.paginate.hasNextPages = exports.hasNextPages(req);
      res.locals.paginate.getArrayPages = exports.getArrayPages(req);
  
      next();
  
    };
  
  }

• example usage

  ...
  ```
  
  ### paginate
  
  This creates a new instance of `express-paginate`.
  
  
  ### paginate.middleware(limit, maxLimit)
  
  This middleware validates and supplies default values to `req.skip` (an alias of `req.offset`, which can be used to skip or offset
   a number of records for pagination, e.g. with Mongoose you would do `Model.find().skip(req.skip)`), `req.query.limit`, `req.query
  .page`, `res.locals.paginate`, `res.locals.hasPreviousPages`, and `res.locals.hasNextPages`.
  
  #### Arguments
  
  * `limit` a Number to limit results returned per page (defaults to `10`)
  * `maxLimit` a Number to restrict the number of results returned to per page (defaults to `50`) – through this, users
   will not be able to override this limit (e.g. they can't pass `?limit=10000` and crash your server)
  ...