@xylabs/promise - npm Package Compare versions

Comparing version 2.6.16 to 2.7.0

.tsconfig.build.cjs.json

 {
   "compilerOptions": {
+    "rootDir": "./src",
+    "rootDirs": [
+      "package.json"
+    ],
+    "baseUrl": ".",
+    "composite": true,
+    "declarationDir": "./dist/types",
+    "outDir": "././dist/cjs",
     "module": "CommonJS",
-    "outDir": "./dist/cjs",
     "target": "ES6"
   },
+  "extends": "../../tsconfig.json",
+  "include": [
+    "src/**/*",
+    "src"
+  ],
   "exclude": [
+    "**/build",
+    "**/dist",
+    "**/node_modules",
     "**/*.spec.*",
@@ -14,7 +29,3 @@ "**/*.spec",
     "**/stories/*"
-  ],
-  "extends": "./tsconfig.json",
-  "include": [
-    "src"
   ]
 }

.tsconfig.build.esm.json

 {
   "compilerOptions": {
-    "module": "ES2022",
-    "outDir": "./dist/esm",
-    "target": "ES2022"
+    "rootDir": "./src",
+    "rootDirs": [
+      "package.json"
+    ],
+    "baseUrl": ".",
+    "composite": true,
+    "declarationDir": "./dist/types",
+    "outDir": "././dist/esm",
+    "module": "ESNext",
+    "target": "ESNext"
   },
+  "extends": "../../tsconfig.json",
+  "include": [
+    "src/**/*",
+    "src"
+  ],
   "exclude": [
+    "**/build",
+    "**/dist",
+    "**/node_modules",
     "**/*.spec.*",
@@ -14,7 +29,3 @@ "**/*.spec",
     "**/stories/*"
-  ],
-  "extends": "./tsconfig.json",
-  "include": [
-    "src"
   ]
 }

dist/cjs/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rejected = exports.fulfilled = void 0;
+exports.rejected = exports.fulfilledValues = exports.fulfilled = void 0;
 const fulfilled_1 = require("./fulfilled");
 Object.defineProperty(exports, "fulfilled", { enumerable: true, get: function () { return fulfilled_1.fulfilled; } });
+const fulfilledValues_1 = require("./fulfilledValues");
+Object.defineProperty(exports, "fulfilledValues", { enumerable: true, get: function () { return fulfilledValues_1.fulfilledValues; } });
 const rejected_1 = require("./rejected");
 Object.defineProperty(exports, "rejected", { enumerable: true, get: function () { return rejected_1.rejected; } });
 //# sourceMappingURL=index.js.map

dist/docs.json

@@ -20,3 +20,3 @@ {
 					"character": 13,
-					"url": "https://github.com/xylabs/sdk-js/blob/5cd9095/packages/promise/src/fulfilled.ts#L6"
+					"url": "https://github.com/xylabs/sdk-js/blob/089a04a/packages/promise/src/fulfilled.ts#L6"
 				}
@@ -99,2 +99,120 @@ ],
 			"id": 5,
+			"name": "fulfilledValues",
+			"kind": 64,
+			"kindString": "Function",
+			"flags": {},
+			"sources": [
+				{
+					"fileName": "fulfilledValues.ts",
+					"line": 19,
+					"character": 13,
+					"url": "https://github.com/xylabs/sdk-js/blob/089a04a/packages/promise/src/fulfilledValues.ts#L19"
+				}
+			],
+			"signatures": [
+				{
+					"id": 6,
+					"name": "fulfilledValues",
+					"kind": 4096,
+					"kindString": "Call signature",
+					"flags": {},
+					"comment": {
+						"summary": [
+							{
+								"kind": "text",
+								"text": "For use with Promise.allSettled to reduce to only successful result values"
+							}
+						],
+						"blockTags": [
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "text",
+										"text": "Casting the initialValue provided to reduce\n"
+									},
+									{
+										"kind": "code",
+										"text": "```ts\nconst resolved = Promise.resolve('resolved')\nconst rejected = Promise.reject('rejected')\nconst settled = await Promise.allSettled([resolved, rejected])\nconst results = settled.reduce(fulfilledValues, [] as string[])\n// results === [ 'resolved' ]\n```"
+									}
+								]
+							},
+							{
+								"tag": "@example",
+								"content": [
+									{
+										"kind": "text",
+										"text": "Providing type parameter to reduce and initialValue type can be inferred\n"
+									},
+									{
+										"kind": "code",
+										"text": "```ts\nconst resolved = Promise.resolve('resolved')\nconst rejected = Promise.reject('rejected')\nconst settled = await Promise.allSettled([resolved, rejected])\nconst results = settled.reduce<string[]>(fulfilledValues, [])\n// results === [ 'resolved' ]\n```"
+									}
+								]
+							},
+							{
+								"tag": "@returns",
+								"content": []
+							}
+						]
+					},
+					"typeParameter": [
+						{
+							"id": 7,
+							"name": "T",
+							"kind": 131072,
+							"kindString": "Type parameter",
+							"flags": {}
+						}
+					],
+					"parameters": [
+						{
+							"id": 8,
+							"name": "previousValue",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "array",
+								"elementType": {
+									"type": "reference",
+									"id": 7,
+									"name": "T"
+								}
+							}
+						},
+						{
+							"id": 9,
+							"name": "currentValue",
+							"kind": 32768,
+							"kindString": "Parameter",
+							"flags": {},
+							"type": {
+								"type": "reference",
+								"typeArguments": [
+									{
+										"type": "reference",
+										"id": 7,
+										"name": "T"
+									}
+								],
+								"name": "PromiseSettledResult",
+								"qualifiedName": "PromiseSettledResult",
+								"package": "typescript"
+							}
+						}
+					],
+					"type": {
+						"type": "array",
+						"elementType": {
+							"type": "reference",
+							"id": 7,
+							"name": "T"
+						}
+					}
+				}
+			]
+		},
+		{
+			"id": 10,
 			"name": "rejected",
@@ -109,3 +227,3 @@ "kind": 64,
 					"character": 13,
-					"url": "https://github.com/xylabs/sdk-js/blob/5cd9095/packages/promise/src/rejected.ts#L6"
+					"url": "https://github.com/xylabs/sdk-js/blob/089a04a/packages/promise/src/rejected.ts#L6"
 				}
@@ -115,3 +233,3 @@ ],
 				{
-					"id": 6,
+					"id": 11,
 					"name": "rejected",
@@ -137,3 +255,3 @@ "kind": 4096,
 						{
-							"id": 7,
+							"id": 12,
 							"name": "T",
@@ -147,3 +265,3 @@ "kind": 131072,
 						{
-							"id": 8,
+							"id": 13,
 							"name": "val",
@@ -158,3 +276,3 @@ "kind": 32768,
 										"type": "reference",
-										"id": 7,
+										"id": 12,
 										"name": "T"
@@ -189,3 +307,4 @@ }
 				1,
-				5
+				5,
+				10
 			]
@@ -199,5 +318,5 @@ }
 			"character": 0,
-			"url": "https://github.com/xylabs/sdk-js/blob/5cd9095/packages/promise/src/index.ts#L1"
+			"url": "https://github.com/xylabs/sdk-js/blob/089a04a/packages/promise/src/index.ts#L1"
 		}
 	]
 }

dist/esm/index.js

 import { fulfilled } from './fulfilled';
+import { fulfilledValues } from './fulfilledValues';
 import { rejected } from './rejected';
-export { fulfilled, rejected };
+export { fulfilled, fulfilledValues, rejected };
 //# sourceMappingURL=index.js.map

dist/types/index.d.ts

 import { fulfilled } from './fulfilled';
+import { fulfilledValues } from './fulfilledValues';
 import { rejected } from './rejected';
-export { fulfilled, rejected };
+export { fulfilled, fulfilledValues, rejected };
 //# sourceMappingURL=index.d.ts.map

package.json

@@ -44,3 +44,3 @@ {
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^2.12.23"
+    "@xylabs/ts-scripts-yarn3": "^2.13.11"
   },
@@ -55,3 +55,3 @@ "publishConfig": {
   "sideEffects": false,
-  "version": "2.6.16"
+  "version": "2.7.0"
 }

src/fulfilled.spec.ts

@@ -13,17 +13,16 @@ import { fulfilled } from './fulfilled'
   it('returns true for resolved promises', async () => {
-    const results = await getAllResolvedPromises()
-    expect(results).toBeTruthy()
-    expect(results.length).toBe(1)
-    const filtered = results.filter(fulfilled)
-    expect(filtered).toBeArrayOfSize(1)
-    const value = filtered[0]
-    expect(value.value).toBeTruthy()
+    const promiseSettledResults = await getAllResolvedPromises()
+    expect(promiseSettledResults).toBeTruthy()
+    expect(promiseSettledResults.length).toBe(1)
+    const results = promiseSettledResults.filter(fulfilled)
+    expect(results).toBeArrayOfSize(1)
+    results.map((result) => expect(result.value).toBe('yes'))
   })
   it('returns false for rejected promises', async () => {
-    const results = await getAllRejectedPromises()
-    expect(results).toBeTruthy()
-    expect(results.length).toBe(1)
-    const filtered = results.filter(fulfilled)
-    expect(filtered).toBeArrayOfSize(0)
+    const promiseSettledResults = await getAllRejectedPromises()
+    expect(promiseSettledResults).toBeTruthy()
+    expect(promiseSettledResults.length).toBe(1)
+    const results = promiseSettledResults.filter(fulfilled)
+    expect(results).toBeArrayOfSize(0)
   })
 })

src/index.ts

 import { fulfilled } from './fulfilled'
+import { fulfilledValues } from './fulfilledValues'
 import { rejected } from './rejected'
 
-export { fulfilled, rejected }
+export { fulfilled, fulfilledValues, rejected }

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

76677

increased by16.77%

Number of package files

43

increased by22.86%

Lines of code

642

increased by68.06%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes