pip-services4-components-node/src/run/Closer.ts

Portable Component Model in Node.js / ES2017

/** @module run */

import { IContext } from "../context/IContext";

/**
 * Helper class that closes previously opened components.
 * 
 * [[IClosable]]
 */
export class Closer {
    /**
     * Closes specific component.
     * 
     * To be closed components must implement [[ICloseable]] interface.
     * If they don't the call to this method has no effect.
     * 
     * @param context     (optional) execution context to trace execution through call chain.
     * @param component         the component that is to be closed.
     * 
     * @see [[IClosable]]
     */
    public static async closeOne(context: IContext, component: any): Promise<void> {
        if (typeof component.close === "function") {
            await component.close(context);
        }
    }

    /**
     * Closes multiple components.
     * 
     * To be closed components must implement [[ICloseable]] interface.
     * If they don't the call to this method has no effect.
     * 
     * @param context     (optional) execution context to trace execution through call chain.
     * @param components         the list of components that are to be closed.
     * 
     * @see [[closeOne]]
     * @see [[IClosable]]
     */
    public static async close(context: IContext, components: any[]): Promise<void> {
        for (const component of components) {
            await Closer.closeOne(context, component);
        }
    }
}