p-throttle - npm Package Compare versions

Comparing version 5.0.0 to 5.1.0

index.d.ts

@@ -13,11 +13,16 @@ export class AbortError extends Error {
 	/**
-		Whether future function calls should be throttled or count towards throttling thresholds.
+	Whether future function calls should be throttled or count towards throttling thresholds.
 
-		@default true
-		*/
+	@default true
+	*/
 	isEnabled: boolean;
 
 	/**
-		Abort pending executions. All unresolved promises are rejected with a `pThrottle.AbortError` error.
-		*/
+	The number of queued items waiting to be executed.
+	*/
+	readonly queueSize: number;
+
+	/**
+	Abort pending executions. All unresolved promises are rejected with a `pThrottle.AbortError` error.
+	*/
 	abort(): void;
@@ -24,0 +29,0 @@ };

index.js

@@ -95,4 +95,10 @@ export class AbortError extends Error {
 
+		Object.defineProperty(throttled, 'queueSize', {
+			get() {
+				return queue.size;
+			},
+		});
+
 		return throttled;
 	};
 }

package.json

 {
 	"name": "p-throttle",
-	"version": "5.0.0",
+	"version": "5.1.0",
 	"description": "Throttle promise-returning & async functions",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -99,2 +99,8 @@ # p-throttle
 
+### throttledFn.queueSize
+
+Type: `number`
+
+The number of queued items waiting to be executed.
+
 ## Related
@@ -101,0 +107,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8698

increased by3.3%

Lines of code

147

increased by6.52%

Number of lines in readme file

111

increased by5.71%

No dependency changes