UNPKG

@push.rocks/smartstream

Version:

A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.

24 lines (23 loc) 750 B
import * as plugins from './smartstream.plugins.js'; export interface ITruncateFunc { (): void; } export interface IPipeMoreFunc { (pipeObject: any): void; } export interface IStreamTools { truncate: ITruncateFunc; pipeMore: IPipeMoreFunc; } export interface IStreamFunction<T, rT> { (chunkArg: T, toolsArg: IStreamTools): Promise<rT>; } export interface IStreamEndFunction<rT> { (toolsArg: IStreamTools): Promise<rT>; } export interface IStreamOptions { objectMode?: boolean; readableObjectMode?: boolean; writableObjectMode?: boolean; } export declare let createDuplexStream: <T, rT>(funcArg: IStreamFunction<T, rT>, endFuncArg?: IStreamEndFunction<rT>, optionsArg?: IStreamOptions) => plugins.stream.Transform;