template-project/node_modules/batch-cluster/dist/Parser.d.ts
2025-05-30 18:13:30 +08:00

25 lines
878 B
TypeScript

/**
* Parser implementations convert stdout and stderr from the underlying child
* process to a more useable format. This can be a no-op passthrough if no
* parsing is necessary.
*/
export interface Parser<T> {
/**
* Invoked once per task.
*
* @param stdout the concatenated stream from `stdin`, stripped of the `PASS`
* or `FAIL` tokens from `BatchProcessOptions`.
*
* @param stderr if defined, includes all text emitted to stderr.
*
* @param passed `true` iff the `PASS` pattern was found in stdout.
*
* @throws an error if the Parser implementation wants to reject the task. It
* is valid to raise Errors if stderr is undefined.
*
* @see BatchProcessOptions
*/
(stdout: string, stderr: string | undefined, passed: boolean): T | Promise<T>;
}
export declare const SimpleParser: Parser<string>;