1. module redlock
   1. function redlock (clients, options)
   2. function redlock.Lock (redlock, resource, value, expiration)
   3. function redlock.LockError (message)
   4. function redlock.LockError.super_ ()
   5. function redlock.super_ ()
   6. object redlock.Lock.prototype
2. module redlock.Lock
   1. function redlock.Lock (redlock, resource, value, expiration)
3. module redlock.Lock.prototype
   1. function redlock.Lock.prototype.extend (ttl, callback)
   2. function redlock.Lock.prototype.unlock (callback)
4. module redlock.LockError
   1. function redlock.LockError (message)
   2. function redlock.LockError.super_ ()
5. module redlock.LockError.super_
   1. function redlock.LockError.super_ ()
   2. function redlock.LockError.super_.captureStackTrace ()
   3. number redlock.LockError.super_.stackTraceLimit

module redlock

function redlock (clients, options)

• description and source-code

  function Redlock(clients, options) {
  	// set default options
  	options = options || {};
  	this.driftFactor = typeof options.driftFactor === 'number' ? options.driftFactor : defaults.driftFactor;
  	this.retryCount  = typeof options.retryCount  === 'number' ? options.retryCount  : defaults.retryCount;
  	this.retryDelay  = typeof options.retryDelay  === 'number' ? options.retryDelay  : defaults.retryDelay;
  	this.lockScript  = typeof options.lockScript  === 'function' ? options.lockScript(lockScript) : lockScript;
  	this.unlockScript = typeof options.unlockScript  === 'function' ? options.unlockScript(unlockScript) : unlockScript;
  	this.extendScript = typeof options.extendScript  === 'function' ? options.extendScript(extendScript) : extendScript;
  
  	// set the redis servers from additional arguments
  	this.servers = clients;
  	if(this.servers.length === 0)
  		throw new Error('Redlock must be instantiated with at least one redis server.');
  }

• example usage

  n/a

function redlock.Lock (redlock, resource, value, expiration)

• description and source-code

  function Lock(redlock, resource, value, expiration) {
  	this.redlock    = redlock;
  	this.resource   = resource;
  	this.value      = value;
  	this.expiration = expiration;
  }

• example usage

  n/a

function redlock.LockError (message)

• description and source-code

  function LockError(message) {
  	Error.call(this);
  	Error.captureStackTrace(this, LockError);
  	this.name = 'LockError';
  	this.message = message || 'Failed to lock the resource.';
  }

• example usage

  n/a

function redlock.LockError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

function redlock.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module redlock.Lock

function redlock.Lock (redlock, resource, value, expiration)

• description and source-code

  function Lock(redlock, resource, value, expiration) {
  	this.redlock    = redlock;
  	this.resource   = resource;
  	this.value      = value;
  	this.expiration = expiration;
  }

• example usage

  n/a

module redlock.Lock.prototype

function redlock.Lock.prototype.extend (ttl, callback)

• description and source-code

  function extend(ttl, callback) {
  	return this.redlock.extend(this, ttl, callback);
  }

• example usage

  ...
  ```js
  redlock.lock('locks:account:322456', 1000).then(function(lock) {
  
  	// ...do something here...
  
  	// if you need more time, you can continue to extend
  	// the lock as long as you never let it expire
  	return lock.extend(1000).then(function(lock){
  
  		// ...do something here...
  
  		// unlock your resource when you are done
  		return lock.unlock()
  		.catch(function(err) {
  			// we weren't able to reach redis; your lock will eventually
  ...

function redlock.Lock.prototype.unlock (callback)

• description and source-code

  function unlock(callback) {
  	return this.redlock.unlock(this, callback);
  }

• example usage

  ...
  var ttl = 1000;
  
  redlock.lock(resource, ttl).then(function(lock) {
  
  	// ...do something here...
  
  	// unlock your resource when you are done
  	return lock.unlock()
  	.catch(function(err) {
  		// we weren't able to reach redis; your lock will eventually
  		// expire, but you probably want to log this error
  		console.error(err);
  	});
  });
  ...

module redlock.LockError

function redlock.LockError (message)

• description and source-code

  function LockError(message) {
  	Error.call(this);
  	Error.captureStackTrace(this, LockError);
  	this.name = 'LockError';
  	this.message = message || 'Failed to lock the resource.';
  }

• example usage

  n/a

function redlock.LockError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

module redlock.LockError.super_

function redlock.LockError.super_ ()

• description and source-code

  function Error() { [native code] }

• example usage

  n/a

function redlock.LockError.super_.captureStackTrace ()

• description and source-code

  function captureStackTrace() { [native code] }

• example usage

  ...
  
  
  // LockError
  // ---------
  // This error is returned when there is an error locking a resource.
  function LockError(message) {
  	Error.call(this);
  	Error.captureStackTrace(this, LockError);
  	this.name = 'LockError';
  	this.message = message || 'Failed to lock the resource.';
  }
  
  util.inherits(LockError, Error);
  ...