@playform/pipe/Target/Interface/Plan.d.ts

Pipe 🧪

import type Cache from "../Interface/Cache.js";
import type Dir from "../Interface/Dir.js";
import type File from "../Interface/File.js";
import type Logger from "../Type/Logger.js";
/**
 * @module Plan
 *
 * Represents the execution's plan. It contains information about the tasks to be executed and their corresponding inputs and outputs.
 *
 */
export default interface Interface {
    /**
     * Represents the cache configuration.
     *
     */
    Cache: Cache;
    /**
     * The debugging level for the execution plan.
     *
     */
    Logger: Logger;
    /**
     * The number of files in the execution plan.
     *
     */
    File: number;
    /**
     * Additional information associated with the execution plan.
     *
     */
    Info: any;
    /**
     * Mapping of input paths to output paths.
     *
     */
    Paths: Map<Dir["Input"], Dir["Output"]>;
    /**
     * Mapping of result paths to corresponding input paths.
     *
     */
    Results: Map<`${Dir["Output"]}${File["Output"]}`, `${Dir["Input"]}${File["Input"]}`>;
    /**
     * The file currently being operated on.
     *
     */
    On: File;
}