smartstream/dist/index.d.ts

/// <reference types="q" />
import * as plugins from './smartstream.plugins';
export interface IErrorFunction {
    (err: any): any;
}
export interface ICustomEventFunction {
    (): any;
}
export interface ICustomEventObject {
    eventName: string;
    eventFunction: ICustomEventFunction;
}
/**
 * class Smartstream handles
 */
export declare class Smartstream {
    private streamArray;
    private errorFunction;
    private customEventObjectArray;
    private streamStartedDeferred;
    /**
     * constructor
     */
    constructor(streamArrayArg: any[]);
    /**
     * attach an error handler to the stream to prevent throwing
     */
    onError(errorFunctionArg: IErrorFunction): void;
    /**
     * make something with the stream itself
     */
    streamStarted(): plugins.q.Promise<any>;
    /**
     * attach listener to custom event
     */
    onCustomEvent(eventNameArg: string, eventFunctionArg: ICustomEventFunction): void;
    /**
     * run the stream
     * @returns Promise
     */
    run(): plugins.q.Promise<void>;
}