redlock.d.ts

// Type definitions for Redlock
// Project: https://github.com/mike-marcacci/node-redlock
// Definitions by: Ilya Mochalov <https://github.com/chrootsu>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference path="../bluebird/bluebird.d.ts" />
/// <reference path="../redis/redis.d.ts" />


declare module "redlock" {

	import * as redis from 'redis';
	import * as Promise from 'bluebird';	
		
	namespace Redlock {
		
		interface Callback<T> {
			(err: any, value?: T): void;
		}

		interface Lock {
			
			redlock: Redlock;
			resource: string;
			value: any;
			expiration: number;

			unlock(callback?: Callback<void>): Promise<void>;

			extend(ttl: number, callback?: Callback<Lock>): Promise<Lock>;
		}

		interface Options {
			driftFactor?: number;
			retryCount?: number;
			retryDelay?: number;
		}

		interface LockError extends Error {}
	}
	
	class Redlock {

		driftFactor: number;
		retryCount: number;
		retryDelay: number;

		servers: redis.RedisClient[];

		constructor(clients: any[], options?: Redlock.Options);

		acquire(resource: string, ttl: number, callback?: Redlock.Callback<Redlock.Lock>): Promise<Redlock.Lock>;
		lock(resource: string, ttl: number, callback?: Redlock.Callback<Redlock.Lock>): Promise<Redlock.Lock>;

		disposer(resource: string, ttl: number, errorHandler?: Redlock.Callback<void>): any; // bluebird Disposer

		release(lock:  Redlock.Lock, callback?: Redlock.Callback<void>): Promise<void>;
		unlock(lock:  Redlock.Lock, callback?: Redlock.Callback<void>): Promise<void>;

		extend(lock:  Redlock.Lock, ttl: number, callback?: Redlock.Callback<Redlock.Lock>): Promise<Redlock.Lock>;
	}
	
	export = Redlock;
}