chronoman/index.d.ts

Utility class to simplify use of timers created by setTimeout

// Created on the basis of http://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-class-d-ts.html

export as namespace Chronoman;

export = Timer;

export function getRandomValue(start: any[] | number, end?: number, bInteger?: boolean): any;

export class Timer {
    constructor(initValue?: Timer.Properties);

    protected _period: Timer.Period | null;
    getPeriod(): Timer.Period | null;
    setPeriod(period: Timer.Period | null): Timer;
    getPeriodValue(period?: Timer.Period): number;

    protected _recurrent: boolean;
    isRecurrent(): boolean;
    setRecurrent(recurrent: boolean): Timer;

    protected _repeatQty: number;
    getRepeatQty(): number;
    setRepeatQty(qty: number): Timer;

    protected _repeatTest: Timer.RepeatTest | null;
    getRepeatTest(): Timer.RepeatTest | null;
    setRepeatTest(test: Timer.RepeatTest | null): Timer;

    protected _data: any;
    getData(): any;
    setData(data: any): Timer;

    protected _executionQty: number;
    getExecutionQty(): number;
    setExecutionQty(qty: number): Timer;

    protected _timeoutId: number | null;
    protected _setTimeout(timeout?: Timer.Period): Timer;
    protected _clearTimeout(): Timer;

    protected _startTime: number | null;
    getStartTime(): number | null;
    protected _stopTime: number | null;
    getStopTime(): number | null;
    protected _executeTime: number[];
    getExecuteTime(): number[];

    protected _active: boolean;
    isActive(): boolean;
    setActive(active: boolean): Timer;

    start(periodOrProps?: number | Timer.Properties): Timer;
    stop(): Timer;

    protected _action: Timer.Action | null;
    getAction(): Timer.Action | null;
    setAction(action: Timer.Action | null): Timer;

    protected _passToAction: boolean;
    isPassToAction(): boolean;
    setPassToAction(pass: boolean): Timer;

    setProperties(propMap: Timer.Properties): Timer;

    actionResult: any;

    onExecute: Timer.ActionFunction | null;
    onExecuteResult: any;

    execute(): Timer;

    dispose(): void;

    toString(): string;
}

declare namespace Timer {
    export type ActionContext = {[field in number | string]: any};
    export type ActionFunction = (timer?: Timer) => any;

    export interface ActionObject {
        execute: ActionFunction;
        [field: string]: any;
    }

    export interface ActionSpec {
        context?: ActionContext;
        func: ActionFunction;
        [field: string]: any;
    }

    export type Action = ActionFunction | ActionObject | ActionSpec;

    export interface RandomPeriod {
        list?: number[];
        start?: number;
        end?: number;
    }

    export type SinglePeriodValue = number | RandomPeriod;
    export type PeriodValue = SinglePeriodValue | SinglePeriodValue[];

    export type PeriodFunction = (timer?: Timer) => PeriodValue;

    export type Period = PeriodValue | PeriodFunction;

    export type RepeatTest = (timer: Timer) => boolean | Period;

    export interface Properties {
        action?: Action;
        active?: boolean;
        data?: any;
        passToAction?: boolean;
        period?: Period;
        recurrent?: boolean;
        repeatQty?: number;
        repeatTest?: RepeatTest;
    }
}