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

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

/** @module run */
import { Parameters } from './Parameters';
/**
 * Interface for components that can be called to execute work.
 *
 * @see [[Executor]]
 * @see [[INotifiable]]
 * @see [[Parameters]]
 *
 * ### Example ###
 *
 *     class EchoComponent implements IExecutable {
 *         ...
 *         public async execute(correlationId: string, args: Parameters): Promise<any> {
 *             let result = args.getAsObject("message");
 *             return result;
 *         }
 *     }
 *
 *     let echo = new EchoComponent();
 *     let message = "Test";
 *     let result = await echo.execute("123", Parameters.fromTuples("message", message))
 *     console.log("Request: " + message + " Response: " + result);
 */
export interface IExecutable {
    /**
     * Executes component with arguments and receives execution result.
     *
     * @param correlationId 	(optional) transaction id to trace execution through call chain.
     * @param args 				execution arguments.
     * @result 					the execution result.
     */
    execute(correlationId: string, args: Parameters): Promise<any>;
}