// Type definitions for Async 0.9.2
// Project: https://github.com/caolan/async
// Definitions by: Boris Yankov , Arseniy Maximov
// Definitions: https://github.com/borisyankov/DefinitelyTyped
interface Dictionary { [key: string]: T; }
// Common interface between Arrays and Array-like objects
interface List {
[index: number]: T;
length: number;
}
interface ErrorCallback { (err?: Error): void; }
interface AsyncResultCallback { (err: Error, result: T): void; }
interface AsyncResultArrayCallback { (err: Error, results: T[]): void; }
interface AsyncResultObjectCallback { (err: Error, results: Dictionary): void; }
interface AsyncIterator { (item: T, callback: ErrorCallback): void; }
interface AsyncForEachOfIterator { (item: T, index: number, callback: ErrorCallback): void; }
interface AsyncResultIterator { (item: T, callback: AsyncResultCallback): void; }
interface AsyncMemoIterator { (memo: R, item: T, callback: AsyncResultCallback): void; }
interface AsyncWorker { (task: T, callback: ErrorCallback): void; }
interface AsyncFunction { (callback: AsyncResultCallback): void; }
interface AsyncVoidFunction { (callback: ErrorCallback): void; }
interface AsyncQueue {
length(): number;
concurrency: number;
started: boolean;
paused: boolean;
push(task: T, callback?: ErrorCallback): void;
push(task: T[], callback?: ErrorCallback): void;
unshift(task: T, callback?: ErrorCallback): void;
unshift(task: T[], callback?: ErrorCallback): void;
saturated: () => any;
empty: () => any;
drain: () => any;
running(): number;
idle(): boolean;
pause(): void;
resume(): void;
kill(): void;
}
interface AsyncPriorityQueue {
length(): number;
concurrency: number;
started: boolean;
paused: boolean;
push(task: T, priority: number, callback?: AsyncResultArrayCallback): void;
push(task: T[], priority: number, callback?: AsyncResultArrayCallback): void;
saturated: () => any;
empty: () => any;
drain: () => any;
running(): number;
idle(): boolean;
pause(): void;
resume(): void;
kill(): void;
}
interface Async {
// Collections
each(arr: T[], iterator: AsyncIterator, callback: ErrorCallback): void;
eachSeries(arr: T[], iterator: AsyncIterator, callback: ErrorCallback): void;
eachLimit(arr: T[], limit: number, iterator: AsyncIterator, callback: ErrorCallback): void;
forEachOf(obj: List, iterator: AsyncForEachOfIterator, callback: ErrorCallback): void;
forEachOfSeries(obj: List, iterator: AsyncForEachOfIterator, callback: ErrorCallback): void;
forEachOfLimit(obj: List, limit: number, iterator: AsyncForEachOfIterator, callback: ErrorCallback): void;
map(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
mapSeries(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
mapLimit(arr: T[], limit: number, iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
filter(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
select(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
filterSeries(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
selectSeries(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
reject(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
rejectSeries(arr: T[], iterator: AsyncResultIterator, callback: (results: T[]) => any): any;
reduce(arr: T[], memo: R, iterator: AsyncMemoIterator, callback: AsyncResultCallback): any;
inject(arr: T[], memo: R, iterator: AsyncMemoIterator, callback: AsyncResultCallback): any;
foldl(arr: T[], memo: R, iterator: AsyncMemoIterator, callback: AsyncResultCallback): any;
reduceRight(arr: T[], memo: R, iterator: AsyncMemoIterator, callback: AsyncResultCallback): any;
foldr(arr: T[], memo: R, iterator: AsyncMemoIterator, callback: AsyncResultCallback): any;
detect(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
detectSeries(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
sortBy(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
some(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
any(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
every(arr: T[], iterator: AsyncResultIterator, callback: (result: boolean) => any): any;
all(arr: T[], iterator: AsyncResultIterator, callback: (result: boolean) => any): any;
concat(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
concatSeries(arr: T[], iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): any;
// Control Flow
series(tasks: Array>, callback?: AsyncResultArrayCallback): void;
series(tasks: Dictionary>, callback?: AsyncResultObjectCallback): void;
parallel(tasks: Array>, callback?: AsyncResultArrayCallback): void;
parallel(tasks: Dictionary>, callback?: AsyncResultObjectCallback): void;
parallelLimit(tasks: Array>, limit: number, callback?: AsyncResultArrayCallback): void;
parallelLimit(tasks: Dictionary>, limit: number, callback?: AsyncResultObjectCallback): void;
whilst(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
doWhilst(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
until(test: () => boolean, fn: AsyncVoidFunction, callback: (err: any) => void): void;
doUntil(fn: AsyncVoidFunction, test: () => boolean, callback: (err: any) => void): void;
waterfall(tasks: Function[], callback?: (err: any, ...arguments: any[]) => void): void;
queue(worker: AsyncWorker, concurrency: number): AsyncQueue;
priorityQueue(worker: AsyncWorker, concurrency: number): AsyncPriorityQueue;
auto(tasks: any, callback?: AsyncResultArrayCallback): void;
iterator(tasks: Function[]): Function;
apply(fn: Function, ...arguments: any[]): AsyncFunction;
nextTick(callback: Function): void;
times (n: number, iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): void;
timesSeries (n: number, iterator: AsyncResultIterator, callback: AsyncResultArrayCallback): void;
// Utils
memoize(fn: Function, hasher?: Function): Function;
unmemoize(fn: Function): Function;
log(fn: Function, ...arguments: any[]): void;
dir(fn: Function, ...arguments: any[]): void;
noConflict(): Async;
}
declare var async: Async;
declare module "async" {
export = async;
}