pip-services3-commons-nodex/src/run/IClosable.ts

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

/** @module run */

/**
 * Interface for components that require explicit closure.
 * 
 * For components that require opening as well as closing 
 * use [[IOpenable]] interface instead.
 * 
 * @see [[IOpenable]]
 * @see [[Closer]]
 * 
 * ### Example ###
 * 
 *     class MyConnector implements ICloseable {
 *         private _client: any = null;
 *         
 *         ... // The _client can be lazy created
 *         
 *         public async close(correlationId: string): Promise<void> {
 *             if (this._client != null) {
 *                 this._client.close();
 *                 this._client = null;
 *             }
 *         }
 *     }
 * 
 */
export interface IClosable {
	/**
	 * Closes component and frees used resources.
	 * 
	 * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param callback 			callback function that receives error or null no errors occured.
	 */
	close(correlationId: string): Promise<void>;
}