lock-queue/lib/defer.js

Simple locking mechanism to serialize (queue) access to a resource

/* --------------------
 * lock-queue module
 * Deferred promise
 * -------------------- */

// Modules
var Promise = require('bluebird');

// Exports

/**
 * Deferred factory.
 *
 * `deferred.promise` is a promise in pending state which can be resolved or rejected
 * by calling `deferred.resolve()` or `deferred.reject()`.
 *
 * @returns {Object} - Deferred object
 * @returns {Promise} .promise
 * @returns {Function} .resolve
 * @returns {Function} .reject
 */
module.exports = function() {
	var deferred = {};

	deferred.promise = new Promise(function(resolve, reject) {
        deferred.resolve = resolve;
        deferred.reject = reject;
    });

	return deferred;
};