batchjs/dist/@types/streams/classes/AllMatchStream.d.ts

Batch processing framework for NodeJS

import { TransformCallback } from "stream";
import { ObjectDuplexOptions, DiscardingSingleObjectDuplex } from "../interfaces/_index";
/**
 * @interface
 * Options for the AllMatchStream.
 * @extends ObjectDuplexOptions
 * @template T
 */
export interface AllMatchStreamOptions<T> extends ObjectDuplexOptions {
    matcher: (chunk: T) => boolean;
}
/**
 * @class
 * Class that allows you to validate that all elements in a stream match a given condition.
 * @extends DiscardingSingleObjectDuplex
 * @template T
 * @example
 * ```typescript
 * const stream:AllMatchStream<string> = new AllMatchStream({
 *     objectMode: true,
 *     matcher: (chunk: string) => chunk.length > 2
 * });
 *
 * stream.write("first"); // match
 * stream.write("second"); // match
 * stream.write("3"); // not match
 * stream.end();
 *
 * stream.on("data", (chunk: boolean) => {
 *     console.log(``Result: ${chunk}```);
 * });
 * ```
 * ```shell
 * >> Result: false
 * ```
 */
export declare class AllMatchStream<T> extends DiscardingSingleObjectDuplex<T, boolean> {
    private readonly _matcher;
    /**
     * @constructor
     * @param {AllMatchStreamOptions} options - The options for the AllMatchStream.
     * @param [options.matcher] {Function} - The function that will be used to validate the chunk.
     */
    constructor(options: AllMatchStreamOptions<T>);
    /**
     * A method to write data to the stream, filter the chunk and push it to the buffer or discard it, and execute the callback.
     *
     * @param {T} chunk - The data chunk to write to the stream.
     * @param {BufferEncoding} encoding - The encoding of the data.
     * @param {TransformCallback} callback - The callback function to be executed after writing the data.
     * @return {void} This function does not return anything.
     */
    _write(chunk: T, encoding: BufferEncoding, callback: TransformCallback): void;
}