@browsery/stream - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

package.json

 {
   "name": "@browsery/stream",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Browser compatible NodeJS stream module",
@@ -5,0 +5,0 @@ "author": "Panates",

typings/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for readable-stream 2.3
+// Type definitions for readable-stream 4.0
 // Project: https://github.com/nodejs/readable-stream
@@ -18,2 +18,4 @@ // Definitions by: TeamworkGuy2 <https://github.com/TeamworkGuy2>
 
+type ComposeFnParam = (source: any) => void;
+
 interface _IEventEmitter {
@@ -40,2 +42,9 @@ addListener(event: string | symbol, listener: (...args: any[]) => void): this;
 
+interface SignalOption {
+    signal?: AbortSignal;
+}
+interface ArrayOptions extends SignalOption {
+    concurrency?: number;
+}
+
 interface _IReadable extends _IEventEmitter {
@@ -52,2 +61,34 @@ _read(size: number): void;
     push(chunk: any, encoding?: string): boolean;
+    iterator(options?: { destroyOnReturn?: boolean }): AsyncIterableIterator<any>;
+    map(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): _Readable.Readable;
+    filter(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): _Readable.Readable;
+    forEach(fn: (data: any, options?: SignalOption) => void | Promise<void>, options?: ArrayOptions): Promise<void>;
+    toArray(options?: SignalOption): Promise<any[]>;
+    some(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): Promise<boolean>;
+    find<T>(fn: (data: any, options?: SignalOption) => data is T, options?: ArrayOptions): Promise<T | undefined>;
+    find(fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>, options?: ArrayOptions): Promise<any>;
+    every(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): Promise<boolean>;
+    flatMap(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): _Readable.Readable;
+    drop(limit: number, options?: SignalOption): _Readable.Readable;
+    take(limit: number, options?: SignalOption): _Readable.Readable;
+    asIndexedPairs(options?: SignalOption): _Readable.Readable;
+    reduce<T = any>(
+        fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+        initial?: undefined,
+        options?: Pick<ArrayOptions, "signal">,
+    ): Promise<T>;
+    reduce<T = any>(
+        fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+        initial: T,
+        options?: Pick<ArrayOptions, "signal">,
+    ): Promise<T>;
     _destroy(error: Error | null, callback: (error?: Error | null) => void): void;
@@ -74,2 +115,33 @@ destroy(error?: Error): this;
     push(chunk: any, encoding?: string): boolean;
+    map(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): _Readable.Readable;
+    filter(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): _Readable.Readable;
+    forEach(fn: (data: any, options?: SignalOption) => void | Promise<void>, options?: ArrayOptions): Promise<void>;
+    toArray(options?: SignalOption): Promise<any[]>;
+    some(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): Promise<boolean>;
+    find<T>(fn: (data: any, options?: SignalOption) => data is T, options?: ArrayOptions): Promise<T | undefined>;
+    find(fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>, options?: ArrayOptions): Promise<any>;
+    every(
+        fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+        options?: ArrayOptions,
+    ): Promise<boolean>;
+    flatMap(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): _Readable.Readable;
+    drop(limit: number, options?: SignalOption): _Readable.Readable;
+    take(limit: number, options?: SignalOption): _Readable.Readable;
+    asIndexedPairs(options?: SignalOption): _Readable.Readable;
+    reduce<T = any>(
+        fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+        initial?: undefined,
+        options?: Pick<ArrayOptions, "signal">,
+    ): Promise<T>;
+    reduce<T = any>(
+        fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+        initial: T,
+        options?: Pick<ArrayOptions, "signal">,
+    ): Promise<T>;
     _destroy(error: Error | null, callback: (error?: Error | null) => void): void;
@@ -147,3 +219,5 @@ destroy(error?: Error): this;
 
+    iterator(options?: { destroyOnReturn?: boolean }): AsyncIterableIterator<any>;
     [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+    [Symbol.asyncDispose](): never;
 
@@ -181,3 +255,7 @@ // static ReadableState: _Readable.ReadableState;
     interface Destroy {
-        destroy(this: Readable | Writable, error: Error | null, callback?: (error: Error | null) => void): Readable | Writable;
+        destroy(
+            this: Readable | Writable,
+            error: Error | null,
+            callback?: (error: Error | null) => void,
+        ): Readable | Writable;
         undestroy(this: Readable | Writable): void;
@@ -193,3 +271,7 @@ }
         write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
-        writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void;
+        writev?(
+            this: Duplex,
+            chunks: Array<{ chunk: any; encoding: BufferEncoding }>,
+            callback: (error?: Error | null) => void,
+        ): void;
         final?(this: Duplex, callback: (error?: Error | null) => void): void;
@@ -201,3 +283,3 @@ destroy?(this: Duplex, error: Error | null, callback: (error: Error | null) => void): void;
 
-    class Duplex extends _Writable implements _IDuplex, /*extends*/_Readable, Duplex {
+    class Duplex extends _Writable implements _IDuplex, /*extends*/ _Readable, Duplex {
         /**
@@ -238,2 +320,33 @@ * This is a dummy function required to retain type compatibility to node.
         push(chunk: any, encoding?: BufferEncoding): boolean;
+        map(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): Readable;
+        filter(fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>, options?: ArrayOptions): Readable;
+        forEach(fn: (data: any, options?: SignalOption) => void | Promise<void>, options?: ArrayOptions): Promise<void>;
+        toArray(options?: SignalOption): Promise<any[]>;
+        some(
+            fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+            options?: ArrayOptions,
+        ): Promise<boolean>;
+        find<T>(fn: (data: any, options?: SignalOption) => data is T, options?: ArrayOptions): Promise<T | undefined>;
+        find(
+            fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+            options?: ArrayOptions,
+        ): Promise<any>;
+        every(
+            fn: (data: any, options?: SignalOption) => boolean | Promise<boolean>,
+            options?: ArrayOptions,
+        ): Promise<boolean>;
+        flatMap(fn: (data: any, options?: SignalOption) => any, options?: ArrayOptions): Readable;
+        drop(limit: number, options?: SignalOption): Readable;
+        take(limit: number, options?: SignalOption): Readable;
+        asIndexedPairs(options?: SignalOption): Readable;
+        reduce<T = any>(
+            fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+            initial?: undefined,
+            options?: Pick<ArrayOptions, "signal">,
+        ): Promise<T>;
+        reduce<T = any>(
+            fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T,
+            initial: T,
+            options?: Pick<ArrayOptions, "signal">,
+        ): Promise<T>;
         _destroy(err: Error | null, callback: (error: Error | null) => void): void;
@@ -246,3 +359,5 @@ destroy(err?: Error, callback?: (error: Error | null) => void): this;
         _undestroy(): void;
+        iterator(options?: { destroyOnReturn?: boolean }): AsyncIterableIterator<any>;
         [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+        [Symbol.asyncDispose](): never;
         // end-Readable
@@ -257,3 +372,7 @@
 
-        _transform<T>(chunk: T, encoding: BufferEncoding | string | null | undefined, callback: (error?: Error, data?: T) => void): void;
+        _transform<T>(
+            chunk: T,
+            encoding: BufferEncoding | string | null | undefined,
+            callback: (error?: Error, data?: T) => void,
+        ): void;
     }
@@ -310,3 +429,7 @@
         constructor(options?: ReadableOptions);
-        pipe<T extends _IWritable>(destination: T, options?: { end?: boolean | undefined; }): T;
+        pipe<T extends _IWritable>(destination: T, options?: { end?: boolean | undefined }): T;
+        compose<T extends NodeJS.ReadableStream>(
+            stream: T | ComposeFnParam | Iterable<T> | AsyncIterable<T>,
+            options?: { signal: AbortSignal },
+        ): T;
     }
@@ -318,6 +441,15 @@
         write?(this: _ITransform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
-        writev?(this: _ITransform, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void;
+        writev?(
+            this: _ITransform,
+            chunks: Array<{ chunk: any; encoding: BufferEncoding }>,
+            callback: (error?: Error | null) => void,
+        ): void;
         final?(this: _ITransform, callback: (error?: Error | null) => void): void;
         destroy?(this: _ITransform, error: Error | null, callback: (error: Error | null) => void): void;
-        transform?(this: _ITransform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null, data?: any) => void): void;
+        transform?(
+            this: _ITransform,
+            chunk: any,
+            encoding: BufferEncoding,
+            callback: (error?: Error | null, data?: any) => void,
+        ): void;
         flush?(callback: (error?: Error | null, data?: any) => void): void;
@@ -405,4 +537,13 @@ };
     type WritableOptions = WritableStateOptions & {
-        write?(this: _IWritable, chunk: any, encoding: BufferEncoding | string, callback: (error?: Error | null) => void): void;
-        writev?(this: _IWritable, chunk: ArrayLike<{ chunk: any; encoding: BufferEncoding | string }>, callback: (error?: Error | null) => void): void;
+        write?(
+            this: _IWritable,
+            chunk: any,
+            encoding: BufferEncoding | string,
+            callback: (error?: Error | null) => void,
+        ): void;
+        writev?(
+            this: _IWritable,
+            chunk: ArrayLike<{ chunk: any; encoding: BufferEncoding | string }>,
+            callback: (error?: Error | null) => void,
+        ): void;
         destroy?(this: _IWritable, error: Error | null, callback: (error: Error | null) => void): void;
@@ -430,3 +571,3 @@ final?(this: _IWritable, callback: (error?: Error | null) => void): void;
         _write(chunk: any, encoding: string, callback: (error?: Error | null) => void): void;
-        _writev?(chunks: Array<{ chunk: any, encoding: string }>, callback: (error?: Error | null) => void): void;
+        _writev?(chunks: Array<{ chunk: any; encoding: string }>, callback: (error?: Error | null) => void): void;
         _destroy(error: Error | null, callback: (error: Error | null) => void): void;
@@ -529,3 +670,7 @@ _final(callback: (error?: Error | null) => void): void;
         constructor(options?: ReadableOptions);
-        pipe<T extends _IWritable>(destination: T, options?: { end?: boolean | undefined; }): T;
+        pipe<T extends _IWritable>(destination: T, options?: { end?: boolean | undefined }): T;
+        compose<T extends NodeJS.ReadableStream>(
+            stream: T | ComposeFnParam | Iterable<T> | AsyncIterable<T>,
+            options?: { signal: AbortSignal },
+        ): T;
     }
@@ -532,0 +677,0 @@ }

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

430470

increased by1.47%

Lines of code

13048

increased by1.11%

No dependency changes