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

Pipe 🧪

import type { Pattern } from "fast-glob";
import type Plan from "../Interface/Plan.js";
/**
 * @module By
 *
 */
export default interface Interface {
    /**
     * The function `By` takes in a file pattern or an array of file patterns, a set
     * of input and output paths, and a map of results, and returns the updated map
     * of results after matching the file patterns with the input paths.
     *
     * @param File - File is either a single file pattern or an array of file
     * patterns. These patterns are used to match files in the input directory
     * (`Input`) that will be processed.
     *
     * @param Paths - Paths is an array of tuples that represent the input and
     * output paths.
     * Each tuple contains two elements: the input path and the output path.
     *
     * @param Results - Map object that stores the mapping between the output file
     * paths and their corresponding input file paths. It is used to keep track of
     * the files that have been processed and their respective destinations.
     *
     */
    (File: Pattern | Pattern[], Paths: Plan["Paths"], Results: Plan["Results"]): Promise<typeof Results>;
}