@decaf-ts/utils/lib/esm/writers/RegexpOutputWriter.d.ts

module management utils for decaf-ts

import { StandardOutputWriter } from "./StandardOutputWriter";
import { PromiseExecutor } from "../utils/types";
/**
 * @description A specialized output writer that uses regular expressions to process output.
 * @summary This class extends StandardOutputWriter to provide regex-based output processing.
 * It allows for pattern matching in the output stream and can trigger specific actions
 * based on matched patterns.
 *
 * @template T - The type of the resolved value, defaulting to string.
 *
 * @param lock - A PromiseExecutor to control the asynchronous flow.
 * @param regexp - A string or RegExp to match against the output.
 * @param flags - Optional flags for the RegExp constructor.
 *
 * @class
 */
export declare class RegexpOutputWriter extends StandardOutputWriter<string> {
    /**
     * @description The regular expression used for matching output.
     * @summary This readonly property stores the compiled RegExp used for pattern matching.
     */
    protected readonly regexp: RegExp;
    /**
     * @description Initializes a new instance of RegexpOutputWriter.
     * @summary Constructs the RegexpOutputWriter with a lock mechanism and a regular expression.
     *
     * @param cmd
     * @param lock - A PromiseExecutor to control the asynchronous flow.
     * @param regexp - A string or RegExp to match against the output.
     * @param flags - Optional flags for the RegExp constructor, defaults to "g".
     */
    constructor(cmd: string, lock: PromiseExecutor<string, Error>, regexp: string | RegExp, flags?: string);
    /**
     * @description Tests the input data against the stored regular expression.
     * @summary Executes the regular expression on the input data and returns the match result.
     *
     * @param data - The string to test against the regular expression.
     * @return The result of the regular expression execution, or undefined if an error occurs.
     */
    private test;
    /**
     * @description Tests the data and resolves the promise if a match is found.
     * @summary Executes the test method and resolves the promise with the first match group if successful.
     *
     * @param data - The string to test against the regular expression.
     */
    protected testAndResolve(data: string): void;
    /**
     * @description Tests the data and rejects the promise if a match is found.
     * @summary Executes the test method and rejects the promise with the first match group if successful.
     *
     * @param data - The string to test against the regular expression.
     */
    protected testAndReject(data: string): void;
    /**
     * @description Processes incoming data chunks.
     * @summary Calls the parent class data method and then tests the data for a match to potentially resolve the promise.
     *
     * @param chunk - The data chunk to process.
     */
    data(chunk: any): void;
    /**
     * @description Processes incoming error chunks.
     * @summary Calls the parent class error method and then tests the data for a match to potentially reject the promise.
     *
     * @param chunk - The error chunk to process.
     */
    error(chunk: any): void;
}