pip-services3-commons-nodex/obj/src/run/IOpenable.d.ts

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

/** @module run */
import { IClosable } from './IClosable';
/**
 * Interface for components that require explicit opening and closing.
 *
 * For components that perform opening on demand consider using
 * [[IClosable]] interface instead.
 *
 * @see [[IOpenable]]
 * @see [[Opener]]
 *
 * ### Example ###
 *
 *     class MyPersistence implements IOpenable {
 *         private _client: any;
 *         ...
 *         public isOpen(): boolean {
 *             return this._client != null;
 *         }
 *
 *         public async open(correlationId: string): Promise<void> {
 *             if (this.isOpen()) {
 *                 return;
 *             }
 *             ...
 *         }
 *
 *         public async close(correlationId: string): Promise<void> {
 *             if (this._client != null) {
 *                 this._client.close();
 *                 this._client = null;
 *             }
 *         }
 *
 *         ...
 *     }
 */
export interface IOpenable extends IClosable {
    /**
     * Checks if the component is opened.
     *
     * @returns true if the component has been opened and false otherwise.
     */
    isOpen(): boolean;
    /**
     * Opens the component.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     */
    open(correlationId: string): Promise<void>;
}