@xylabs/promise 2.9.3 → 2.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/{esm/fulfilledValues.js → index.d.mts} +17 -6
  2. package/dist/{types/fulfilledValues.d.ts → index.d.ts} +17 -2
  3. package/dist/index.js +51 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist/index.mjs +22 -0
  6. package/dist/index.mjs.map +1 -0
  7. package/package.json +28 -14
  8. package/tsup.config.ts +16 -0
  9. package/dist/cjs/fulfilled.js +0 -13
  10. package/dist/cjs/fulfilled.js.map +0 -1
  11. package/dist/cjs/fulfilledValues.js +0 -28
  12. package/dist/cjs/fulfilledValues.js.map +0 -1
  13. package/dist/cjs/index.js +0 -10
  14. package/dist/cjs/index.js.map +0 -1
  15. package/dist/cjs/rejected.js +0 -13
  16. package/dist/cjs/rejected.js.map +0 -1
  17. package/dist/docs.json +0 -430
  18. package/dist/esm/fulfilled.js +0 -9
  19. package/dist/esm/fulfilled.js.map +0 -1
  20. package/dist/esm/fulfilledValues.js.map +0 -1
  21. package/dist/esm/index.js +0 -5
  22. package/dist/esm/index.js.map +0 -1
  23. package/dist/esm/rejected.js +0 -9
  24. package/dist/esm/rejected.js.map +0 -1
  25. package/dist/types/fulfilled.d.ts +0 -7
  26. package/dist/types/fulfilled.d.ts.map +0 -1
  27. package/dist/types/fulfilledValues.d.ts.map +0 -1
  28. package/dist/types/index.d.ts +0 -5
  29. package/dist/types/index.d.ts.map +0 -1
  30. package/dist/types/rejected.d.ts +0 -7
  31. package/dist/types/rejected.d.ts.map +0 -1
  32. package/docs/assets/highlight.css +0 -85
  33. package/docs/assets/main.js +0 -58
  34. package/docs/assets/search.js +0 -1
  35. package/docs/assets/style.css +0 -1367
  36. package/docs/functions/fulfilled.html +0 -61
  37. package/docs/functions/fulfilledValues.html +0 -72
  38. package/docs/functions/rejected.html +0 -61
  39. package/docs/index.html +0 -84
  40. package/docs/modules.html +0 -46
@@ -1,3 +1,10 @@
1
+ /**
2
+ * For use with Promise.allSettled to filter only successful results
3
+ * @param val
4
+ * @returns
5
+ */
6
+ declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
7
+
1
8
  /**
2
9
  * For use with Promise.allSettled to reduce to only successful result values
3
10
  * @example <caption>Casting the initialValue provided to reduce</caption>
@@ -16,9 +23,13 @@
16
23
  * @param currentValue
17
24
  * @returns
18
25
  */
19
- export const fulfilledValues = (previousValue, currentValue) => {
20
- if (currentValue.status === 'fulfilled')
21
- previousValue.push(currentValue.value);
22
- return previousValue;
23
- };
24
- //# sourceMappingURL=fulfilledValues.js.map
26
+ declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
27
+
28
+ /**
29
+ * For use with Promise.allSettled to filter only rejected results
30
+ * @param val
31
+ * @returns
32
+ */
33
+ declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
34
+
35
+ export { fulfilled, fulfilledValues, rejected };
@@ -1,3 +1,10 @@
1
+ /**
2
+ * For use with Promise.allSettled to filter only successful results
3
+ * @param val
4
+ * @returns
5
+ */
6
+ declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
7
+
1
8
  /**
2
9
  * For use with Promise.allSettled to reduce to only successful result values
3
10
  * @example <caption>Casting the initialValue provided to reduce</caption>
@@ -16,5 +23,13 @@
16
23
  * @param currentValue
17
24
  * @returns
18
25
  */
19
- export declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
20
- //# sourceMappingURL=fulfilledValues.d.ts.map
26
+ declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
27
+
28
+ /**
29
+ * For use with Promise.allSettled to filter only rejected results
30
+ * @param val
31
+ * @returns
32
+ */
33
+ declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
34
+
35
+ export { fulfilled, fulfilledValues, rejected };
package/dist/index.js ADDED
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/index.ts
21
+ var src_exports = {};
22
+ __export(src_exports, {
23
+ fulfilled: () => fulfilled,
24
+ fulfilledValues: () => fulfilledValues,
25
+ rejected: () => rejected
26
+ });
27
+ module.exports = __toCommonJS(src_exports);
28
+
29
+ // src/fulfilled.ts
30
+ var fulfilled = (val) => {
31
+ return val.status === "fulfilled";
32
+ };
33
+
34
+ // src/fulfilledValues.ts
35
+ var fulfilledValues = (previousValue, currentValue) => {
36
+ if (currentValue.status === "fulfilled")
37
+ previousValue.push(currentValue.value);
38
+ return previousValue;
39
+ };
40
+
41
+ // src/rejected.ts
42
+ var rejected = (val) => {
43
+ return val.status === "rejected";
44
+ };
45
+ // Annotate the CommonJS export names for ESM import in node:
46
+ 0 && (module.exports = {
47
+ fulfilled,
48
+ fulfilledValues,
49
+ rejected
50
+ });
51
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/fulfilled.ts","../src/fulfilledValues.ts","../src/rejected.ts"],"sourcesContent":["import { fulfilled } from './fulfilled'\nimport { fulfilledValues } from './fulfilledValues'\nimport { rejected } from './rejected'\n\nexport { fulfilled, fulfilledValues, rejected }\n","/**\n * For use with Promise.allSettled to filter only successful results\n * @param val\n * @returns\n */\nexport const fulfilled = <T>(val: PromiseSettledResult<T>): val is PromiseFulfilledResult<T> => {\n return val.status === 'fulfilled'\n}\n","/**\n * For use with Promise.allSettled to reduce to only successful result values\n * @example <caption>Casting the initialValue provided to reduce</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce(fulfilledValues, [] as string[])\n * // results === [ 'resolved' ]\n * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce<string[]>(fulfilledValues, [])\n * // results === [ 'resolved' ]\n * @param previousValue\n * @param currentValue\n * @returns\n */\nexport const fulfilledValues = <T>(previousValue: T[], currentValue: PromiseSettledResult<T>): T[] => {\n if (currentValue.status === 'fulfilled') previousValue.push(currentValue.value)\n return previousValue\n}\n","/**\n * For use with Promise.allSettled to filter only rejected results\n * @param val\n * @returns\n */\nexport const rejected = <T>(val: PromiseSettledResult<T>): val is PromiseRejectedResult => {\n return val.status === 'rejected'\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,IAAM,YAAY,CAAI,QAAmE;AAC9F,SAAO,IAAI,WAAW;AACxB;;;ACWO,IAAM,kBAAkB,CAAI,eAAoB,iBAA+C;AACpG,MAAI,aAAa,WAAW;AAAa,kBAAc,KAAK,aAAa,KAAK;AAC9E,SAAO;AACT;;;AChBO,IAAM,WAAW,CAAI,QAA+D;AACzF,SAAO,IAAI,WAAW;AACxB;","names":[]}
package/dist/index.mjs ADDED
@@ -0,0 +1,22 @@
1
+ // src/fulfilled.ts
2
+ var fulfilled = (val) => {
3
+ return val.status === "fulfilled";
4
+ };
5
+
6
+ // src/fulfilledValues.ts
7
+ var fulfilledValues = (previousValue, currentValue) => {
8
+ if (currentValue.status === "fulfilled")
9
+ previousValue.push(currentValue.value);
10
+ return previousValue;
11
+ };
12
+
13
+ // src/rejected.ts
14
+ var rejected = (val) => {
15
+ return val.status === "rejected";
16
+ };
17
+ export {
18
+ fulfilled,
19
+ fulfilledValues,
20
+ rejected
21
+ };
22
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/fulfilled.ts","../src/fulfilledValues.ts","../src/rejected.ts"],"sourcesContent":["/**\n * For use with Promise.allSettled to filter only successful results\n * @param val\n * @returns\n */\nexport const fulfilled = <T>(val: PromiseSettledResult<T>): val is PromiseFulfilledResult<T> => {\n return val.status === 'fulfilled'\n}\n","/**\n * For use with Promise.allSettled to reduce to only successful result values\n * @example <caption>Casting the initialValue provided to reduce</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce(fulfilledValues, [] as string[])\n * // results === [ 'resolved' ]\n * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>\n * const resolved = Promise.resolve('resolved')\n * const rejected = Promise.reject('rejected')\n * const settled = await Promise.allSettled([resolved, rejected])\n * const results = settled.reduce<string[]>(fulfilledValues, [])\n * // results === [ 'resolved' ]\n * @param previousValue\n * @param currentValue\n * @returns\n */\nexport const fulfilledValues = <T>(previousValue: T[], currentValue: PromiseSettledResult<T>): T[] => {\n if (currentValue.status === 'fulfilled') previousValue.push(currentValue.value)\n return previousValue\n}\n","/**\n * For use with Promise.allSettled to filter only rejected results\n * @param val\n * @returns\n */\nexport const rejected = <T>(val: PromiseSettledResult<T>): val is PromiseRejectedResult => {\n return val.status === 'rejected'\n}\n"],"mappings":";AAKO,IAAM,YAAY,CAAI,QAAmE;AAC9F,SAAO,IAAI,WAAW;AACxB;;;ACWO,IAAM,kBAAkB,CAAI,eAAoB,iBAA+C;AACpG,MAAI,aAAa,WAAW;AAAa,kBAAc,KAAK,aAAa,KAAK;AAC9E,SAAO;AACT;;;AChBO,IAAM,WAAW,CAAI,QAA+D;AACzF,SAAO,IAAI,WAAW;AACxB;","names":[]}
package/package.json CHANGED
@@ -11,28 +11,39 @@
11
11
  "url": "https://github.com/xylabs/sdk-js/issues"
12
12
  },
13
13
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
14
- "browser": "dist/esm/index.js",
15
- "main": "dist/cjs/index.js",
16
- "module": "dist/esm/index.js",
17
14
  "docs": "dist/docs.json",
18
- "types": "dist/types/index.d.ts",
15
+ "types": "dist/index.d.ts",
19
16
  "exports": {
20
17
  ".": {
21
- "node": {
22
- "import": "./dist/esm/index.js",
23
- "require": "./dist/cjs/index.js"
18
+ "require": {
19
+ "types": "./dist/index.d.ts",
20
+ "default": "./dist/index.js"
24
21
  },
25
- "browser": {
26
- "import": "./dist/esm/index.js",
27
- "require": "./dist/cjs/index.js"
28
- },
29
- "default": "./dist/esm/index.js"
22
+ "import": {
23
+ "types": "./dist/index.d.mts",
24
+ "default": "./dist/index.mjs"
25
+ }
30
26
  },
31
27
  "./dist/docs.json": {
32
28
  "default": "./dist/docs.json"
33
29
  },
30
+ "./cjs": {
31
+ "default": "./dist/index.js"
32
+ },
33
+ "./docs": {
34
+ "default": "./dist/docs.json"
35
+ },
36
+ "./esm": {
37
+ "default": "./dist/index.mjs"
38
+ },
34
39
  "./package.json": "./package.json"
35
40
  },
41
+ "main": "dist/index.js",
42
+ "module": "dist/index.mjs",
43
+ "scripts": {
44
+ "package-compile": "tsup && publint",
45
+ "package-recompile": "tsup && publint"
46
+ },
36
47
  "homepage": "https://xylabs.com",
37
48
  "keywords": [
38
49
  "xylabs",
@@ -41,7 +52,10 @@
41
52
  "esm"
42
53
  ],
43
54
  "devDependencies": {
44
- "@xylabs/ts-scripts-yarn3": "^2.17.17"
55
+ "@xylabs/ts-scripts-yarn3": "^2.19.5",
56
+ "@xylabs/tsconfig": "^2.19.5",
57
+ "publint": "^0.2.2",
58
+ "tsup": "^7.2.0"
45
59
  },
46
60
  "publishConfig": {
47
61
  "access": "public"
@@ -51,5 +65,5 @@
51
65
  "url": "https://github.com/xylabs/sdk-js.git"
52
66
  },
53
67
  "sideEffects": false,
54
- "version": "2.9.3"
68
+ "version": "2.10.1"
55
69
  }
package/tsup.config.ts ADDED
@@ -0,0 +1,16 @@
1
+ import { defineConfig } from 'tsup'
2
+
3
+ // eslint-disable-next-line import/no-default-export
4
+ export default defineConfig({
5
+ bundle: true,
6
+ cjsInterop: true,
7
+ clean: true,
8
+ dts: {
9
+ entry: ['src/index.ts'],
10
+ },
11
+ entry: ['src/index.ts'],
12
+ format: ['cjs', 'esm'],
13
+ sourcemap: true,
14
+ splitting: false,
15
+ tsconfig: 'tsconfig.build.json',
16
+ })
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fulfilled = void 0;
4
- /**
5
- * For use with Promise.allSettled to filter only successful results
6
- * @param val
7
- * @returns
8
- */
9
- const fulfilled = (val) => {
10
- return val.status === 'fulfilled';
11
- };
12
- exports.fulfilled = fulfilled;
13
- //# sourceMappingURL=fulfilled.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fulfilled.js","sourceRoot":"","sources":["../../src/fulfilled.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,SAAS,GAAG,CAAI,GAA4B,EAAoC,EAAE;IAC7F,OAAO,GAAG,CAAC,MAAM,KAAK,WAAW,CAAA;AACnC,CAAC,CAAA;AAFY,QAAA,SAAS,aAErB"}
@@ -1,28 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.fulfilledValues = void 0;
4
- /**
5
- * For use with Promise.allSettled to reduce to only successful result values
6
- * @example <caption>Casting the initialValue provided to reduce</caption>
7
- * const resolved = Promise.resolve('resolved')
8
- * const rejected = Promise.reject('rejected')
9
- * const settled = await Promise.allSettled([resolved, rejected])
10
- * const results = settled.reduce(fulfilledValues, [] as string[])
11
- * // results === [ 'resolved' ]
12
- * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>
13
- * const resolved = Promise.resolve('resolved')
14
- * const rejected = Promise.reject('rejected')
15
- * const settled = await Promise.allSettled([resolved, rejected])
16
- * const results = settled.reduce<string[]>(fulfilledValues, [])
17
- * // results === [ 'resolved' ]
18
- * @param previousValue
19
- * @param currentValue
20
- * @returns
21
- */
22
- const fulfilledValues = (previousValue, currentValue) => {
23
- if (currentValue.status === 'fulfilled')
24
- previousValue.push(currentValue.value);
25
- return previousValue;
26
- };
27
- exports.fulfilledValues = fulfilledValues;
28
- //# sourceMappingURL=fulfilledValues.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fulfilledValues.js","sourceRoot":"","sources":["../../src/fulfilledValues.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,eAAe,GAAG,CAAI,aAAkB,EAAE,YAAqC,EAAO,EAAE;IACnG,IAAI,YAAY,CAAC,MAAM,KAAK,WAAW;QAAE,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;IAC/E,OAAO,aAAa,CAAA;AACtB,CAAC,CAAA;AAHY,QAAA,eAAe,mBAG3B"}
package/dist/cjs/index.js DELETED
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.rejected = exports.fulfilledValues = exports.fulfilled = void 0;
4
- const fulfilled_1 = require("./fulfilled");
5
- Object.defineProperty(exports, "fulfilled", { enumerable: true, get: function () { return fulfilled_1.fulfilled; } });
6
- const fulfilledValues_1 = require("./fulfilledValues");
7
- Object.defineProperty(exports, "fulfilledValues", { enumerable: true, get: function () { return fulfilledValues_1.fulfilledValues; } });
8
- const rejected_1 = require("./rejected");
9
- Object.defineProperty(exports, "rejected", { enumerable: true, get: function () { return rejected_1.rejected; } });
10
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AAI9B,0FAJA,qBAAS,OAIA;AAHlB,uDAAmD;AAG/B,gGAHX,iCAAe,OAGW;AAFnC,yCAAqC;AAEA,yFAF5B,mBAAQ,OAE4B"}
@@ -1,13 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.rejected = void 0;
4
- /**
5
- * For use with Promise.allSettled to filter only rejected results
6
- * @param val
7
- * @returns
8
- */
9
- const rejected = (val) => {
10
- return val.status === 'rejected';
11
- };
12
- exports.rejected = rejected;
13
- //# sourceMappingURL=rejected.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"rejected.js","sourceRoot":"","sources":["../../src/rejected.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,QAAQ,GAAG,CAAI,GAA4B,EAAgC,EAAE;IACxF,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,CAAA;AAClC,CAAC,CAAA;AAFY,QAAA,QAAQ,YAEpB"}