@xylabs/promise - npm Package Compare versions

Comparing version 4.2.2 to 4.3.0

dist/neutral/fulfilled.d.ts

@@ -0,2 +1,7 @@
+/**
+ * For use with Promise.allSettled to filter only successful results
+ * @param val
+ * @returns
+ */
 export declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
 //# sourceMappingURL=fulfilled.d.ts.map

dist/neutral/fulfilledValues.d.ts

@@ -0,2 +1,20 @@
+/**
+ * For use with Promise.allSettled to reduce to only successful result values
+ * @example <caption>Casting the initialValue provided to reduce</caption>
+ * const resolved = Promise.resolve('resolved')
+ * const rejected = Promise.reject('rejected')
+ * const settled = await Promise.allSettled([resolved, rejected])
+ * const results = settled.reduce(fulfilledValues, [] as string[])
+ * // results === [ 'resolved' ]
+ * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>
+ * const resolved = Promise.resolve('resolved')
+ * const rejected = Promise.reject('rejected')
+ * const settled = await Promise.allSettled([resolved, rejected])
+ * const results = settled.reduce<string[]>(fulfilledValues, [])
+ * // results === [ 'resolved' ]
+ * @param previousValue
+ * @param currentValue
+ * @returns
+ */
 export declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
 //# sourceMappingURL=fulfilledValues.d.ts.map

dist/neutral/rejected.d.ts

@@ -0,2 +1,7 @@
+/**
+ * For use with Promise.allSettled to filter only rejected results
+ * @param val
+ * @returns
+ */
 export declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
 //# sourceMappingURL=rejected.d.ts.map

dist/neutral/types.d.ts

@@ -8,3 +8,4 @@ import type { PromiseEx } from './PromiseEx.ts';
 export type NullablePromisableArray<T, V = never> = PromisableArray<T | null, V>;
+/** @description Used to document promises that are being used as Mutexes */
 export type AsyncMutex<T> = Promise<T>;
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@xylabs/promise",
-  "version": "4.2.2",
+  "version": "4.3.0",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
@@ -39,4 +39,4 @@ "keywords": [
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.1",
-    "@xylabs/tsconfig": "^4.2.1",
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
     "@xylabs/tsconfig-jest": "^4.1.0",
@@ -43,0 +43,0 @@ "typescript": "^5.6.3"

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

36820

increased by3.34%

Lines of code

384

increased by8.17%

No dependency changes