fix(core): update

This commit is contained in:
2024-02-25 20:14:19 +01:00
parent 60f9e541a5
commit 287695e445
5 changed files with 439 additions and 391 deletions

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@push.rocks/smartstream',
version: '3.0.30',
version: '3.0.31',
description: 'simplifies access to node streams'
}

View File

@ -15,10 +15,28 @@ export interface IStreamFinalFunction<rT> {
}
export interface ISmartDuplexOptions<TInput, TOutput> extends DuplexOptions {
/**
* wether to print debug logs
*/
debug?: boolean;
/**
* the name of the stream
*/
name?: string;
/**
* a function that is being called to read more stuff from whereever to be processed by the stream
* @returns
*/
readFunction?: () => Promise<void>;
/**
* the write function is called for every chunk that is being written to the stream
* it can push or return chunks (but does not have to) to be written to the readable side of the stream
*/
writeFunction?: IStreamWriteFunction<TInput, TOutput>;
/**
* a final function that is being sent to the end of the stream
*/
finalFunction?: IStreamFinalFunction<TOutput>;
// Add other custom options if necessary
}