spex/typescript/spex.d.ts

Specialized Promise Extensions

////////////////////////////////////////
// Requires SPEX v4.0.0 or later.
////////////////////////////////////////

export interface IOriginData {
    readonly success: boolean;
    readonly result: any;
}

export interface IBatchData {
    readonly success: boolean;
    readonly result: any;
    readonly origin?: IOriginData;
}

export interface IBatchStat {
    readonly total: number;
    readonly succeeded: number;
    readonly failed: number;
    readonly duration: number;
}

export interface IStreamReadOptions {
    closable?: boolean;
    readChunks?: boolean;
    readSize?: number;
}

export interface IStreamReadResult {
    readonly calls: number;
    readonly reads: number;
    readonly length: number;
    readonly duration: number;
}

export interface IPageResult {
    readonly pages: number;
    readonly total: number;
    readonly duration: number;
}

export interface ISequenceResult {
    readonly total: number;
    readonly duration: number;
}

export interface IArrayExt<T> extends Array<T> {
    readonly duration: number;
}

export namespace errors {

    // API: http://vitaly-t.github.io/spex/errors.BatchError.html
    class BatchError extends Error {

        // standard error properties:
        name: string;
        message: string;
        stack: string;

        // extended properties:
        data: Array<IBatchData>;

        stat: IBatchStat;

        first: any;

        // API: http://vitaly-t.github.io/spex/errors.BatchError.html#.getErrors
        getErrors(): Array<any>;

        // API: http://vitaly-t.github.io/spex/errors.BatchError.html#.toString
        toString(): string;
    }

    // API: http://vitaly-t.github.io/spex/errors.PageError.html
    class PageError extends Error {

        // standard error properties:
        name: string;
        message: string;
        stack: string;

        // extended properties:
        error: any;
        index: number;
        duration: number;
        reason: string;
        source: any;
        dest: any;

        // API: http://vitaly-t.github.io/spex/errors.PageError.html#.toString
        toString(): string;
    }

    // API: http://vitaly-t.github.io/spex/errors.SequenceError.html
    class SequenceError extends Error {

        // standard error properties:
        name: string;
        message: string;
        stack: string;

        // extended properties:
        error: any;
        index: number;
        duration: number;
        reason: string;
        source: any;
        dest: any;

        // API: http://vitaly-t.github.io/spex/errors.SequenceError.html#.toString
        toString(): string;
    }
}

// API: http://vitaly-t.github.io/spex/stream.html
export namespace stream {
    // API: http://vitaly-t.github.io/spex/stream.html#.read
    function read(stream: any, receiver: (index: number, data: Array<any>, delay: number) => any, options?: IStreamReadOptions): Promise<IStreamReadResult>;
}

// API: http://vitaly-t.github.io/spex/global.html#batch
export function batch<T = unknown>(values: (T | Promise<T>)[], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<IArrayExt<T>>;

export function batch<T1, T2>(values: [T1 | Promise<T1>, T2 | Promise<T2>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2] & IArrayExt<T1 | T2>>;

export function batch<T1, T2, T3>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3] & IArrayExt<T1 | T2 | T3>>;

export function batch<T1, T2, T3, T4>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4] & IArrayExt<T1 | T2 | T3 | T4>>;

export function batch<T1, T2, T3, T4, T5>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5] & IArrayExt<T1 | T2 | T3 | T4 | T5>>;

export function batch<T1, T2, T3, T4, T5, T6>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>, T6 | Promise<T6>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5, T6] & IArrayExt<T1 | T2 | T3 | T4 | T5 | T6>>;

export function batch<T1, T2, T3, T4, T5, T6, T7>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>, T6 | Promise<T6>, T7 | Promise<T7>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5, T6, T7] & IArrayExt<T1 | T2 | T3 | T4 | T5 | T6 | T7>>;

export function batch<T1, T2, T3, T4, T5, T6, T7, T8>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>, T6 | Promise<T6>, T7 | Promise<T7>, T8 | Promise<T8>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5, T6, T7, T8] & IArrayExt<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>>;

export function batch<T1, T2, T3, T4, T5, T6, T7, T8, T9>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>, T6 | Promise<T6>, T7 | Promise<T7>, T8 | Promise<T8>, T9 | Promise<T9>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9] & IArrayExt<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>>;

export function batch<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(values: [T1 | Promise<T1>, T2 | Promise<T2>, T3 | Promise<T3>, T4 | Promise<T4>, T5 | Promise<T5>, T6 | Promise<T6>, T7 | Promise<T7>, T8 | Promise<T8>, T9 | Promise<T9>, T10 | Promise<T10>], options?: {
    cb?: (index: number, success: boolean, result: any, delay: number) => any
}): Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] & IArrayExt<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>>;

// API: http://vitaly-t.github.io/spex/global.html#page
export function page(source: (index: number, data: any, delay: number) => any, options?: {
    dest?: (index: number, data: any, delay: number) => any,
    limit?: number
}): Promise<IPageResult>;

// API: http://vitaly-t.github.io/spex/global.html#sequence
export function sequence(source: (index: number, data: any, delay: number) => any, options?: {
    dest?: (index: number, data: any, delay: number) => any,
    limit?: number,
    track?: boolean
}): Promise<ISequenceResult | IArrayExt<any>>;