pip-services3-commons-node/obj/src/run/Cleaner.d.ts

Portable abstractions and patterns for Pip.Services in Node.js

/**
 * Helper class that cleans stored object state.
 *
 * @see [[ICleanable]]
 */
export declare class Cleaner {
    /**
     * Clears state of specific component.
     *
     * To be cleaned state components must implement [[ICleanable]] interface.
     * If they don't the call to this method has no effect.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param component 		the component that is to be cleaned.
     * @param callback 			callback function that returns error or null no errors occured.
     *
     * @see [[ICleanable]]
     */
    static clearOne(correlationId: string, component: any, callback?: (err: any) => void): void;
    /**
     * Clears state of multiple components.
     *
     * To be cleaned state components must implement [[ICleanable]] interface.
     * If they don't the call to this method has no effect.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param components 		the list of components that are to be cleaned.
     * @param callback 			callback function that returns error or null no errors occured.
     *
     * @see [[clearOne]]
     * @see [[ICleanable]]
     */
    static clear(correlationId: string, components: any[], callback?: (err: any) => void): void;
}