bookshelf-pagemaker/lib/core/methods/order.js

Paginate bookshelf models using various common formats

// Author: Branden Horiuchi <bhoriuchi@gmail.com>
// Description: order the results
//


module.exports = function(env) {
	
	// constants
	var _JTYP      = env.statics.jsTypes;
	var _SCMA      = env.statics.schema;
	var _ORD       = env.statics.order;

	
	// modules
	var _          = env.lodash;
	var methodcore = env.methodcore;
	var utils      = env.utils;
	var u          = utils.util;
	
	
	// return the function
	return function(order) {
		
		var _self     = this;
		
		_self._pagination_var = _.has(_self, '_pagination_var') ? _self._pagination_var : {};
		var _results          = _self._pagination_var.results || null;
		
		var err;
		
		// check resolve input
		_self._pagination_var.results = u.resolveInput(null, _self).then(function(results) {
			
			// throw an error if the results are an error
			if (u.isErr(results.results)) {
				throw results.results;
			}
			
			
			// call the method core function
			methodcore.order(order, _self);
			
			
			// return results
			return results.results;
		})
		.caught(function(e) {

			// create a new error
			err = u.newErr(
				e.errno,
				'An error was thrown during the order call',
				e.code,
				e.message,
				e.stack
			);
			
			// check if the error was thrown by factory or knex/bookshelf
			err = u.isErr(e) ? e : err;
			
			// check if errors should be thrown. usually used for
			// a chained transaction				
			if (_self._pagination_var.throwErrors) {
				throw err;
			}
			
			// return the error
			return u.wrapPromise(err);
		});

		return _self;
	};
};