taskbuffer/dist/taskbuffer.classes.task.d.ts

38 lines
953 B
TypeScript
Raw Normal View History

2016-08-01 14:10:00 +00:00
import * as helpers from "./taskbuffer.classes.helpers";
2016-08-01 11:17:15 +00:00
export interface ITaskFunction {
(x?: any): PromiseLike<any>;
2016-08-01 11:17:15 +00:00
}
2016-05-04 02:28:50 +00:00
export declare class Task {
2016-05-14 02:28:22 +00:00
name: string;
taskFunction: ITaskFunction;
2016-05-04 02:28:50 +00:00
buffered: boolean;
preTask: Task;
afterTask: Task;
2016-08-01 14:10:00 +00:00
running: boolean;
bufferRunner: helpers.BufferRunner;
cycleCounter: helpers.CycleCounter;
idle: boolean;
private _state;
constructor(optionsArg: {
2016-08-01 11:17:15 +00:00
taskFunction: ITaskFunction;
2016-05-04 02:28:50 +00:00
preTask?: Task;
afterTask?: Task;
buffered?: boolean;
2016-05-05 17:21:50 +00:00
bufferMax?: number;
name?: string;
2016-05-04 02:28:50 +00:00
});
2016-08-01 11:17:15 +00:00
/**
* trigger the task. Will trigger buffered if this.buffered is true
*/
trigger(x?: any): PromiseLike<any>;
2016-08-01 11:17:15 +00:00
/**
* trigger task unbuffered.
*/
triggerUnBuffered(x?: any): PromiseLike<any>;
2016-08-01 11:17:15 +00:00
/**
* trigger task buffered.
*/
triggerBuffered(x?: any): PromiseLike<any>;
2016-05-04 02:28:50 +00:00
state: string;
}