@xylabs/promise 2.9.2 → 2.10.0

package/dist/docs.json

@@ -1,430 +0,0 @@
-{
-	"id": 0,
-	"name": "@xylabs/promise",
-	"variant": "project",
-	"kind": 1,
-	"flags": {},
-	"children": [
-		{
-			"id": 1,
-			"name": "fulfilled",
-			"variant": "declaration",
-			"kind": 64,
-			"flags": {},
-			"sources": [
-				{
-					"fileName": "fulfilled.ts",
-					"line": 6,
-					"character": 13,
-					"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/fulfilled.ts#L6"
-				}
-			],
-			"signatures": [
-				{
-					"id": 2,
-					"name": "fulfilled",
-					"variant": "signature",
-					"kind": 4096,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "For use with Promise.allSettled to filter only successful results"
-							}
-						],
-						"blockTags": [
-							{
-								"tag": "@returns",
-								"content": []
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "fulfilled.ts",
-							"line": 6,
-							"character": 25,
-							"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/fulfilled.ts#L6"
-						}
-					],
-					"typeParameter": [
-						{
-							"id": 3,
-							"name": "T",
-							"variant": "typeParam",
-							"kind": 131072,
-							"flags": {}
-						}
-					],
-					"parameters": [
-						{
-							"id": 4,
-							"name": "val",
-							"variant": "param",
-							"kind": 32768,
-							"flags": {},
-							"type": {
-								"type": "reference",
-								"target": {
-									"sourceFileName": "../../node_modules/typescript/lib/lib.es2020.promise.d.ts",
-									"qualifiedName": "PromiseSettledResult"
-								},
-								"typeArguments": [
-									{
-										"type": "reference",
-										"target": -1,
-										"name": "T",
-										"refersToTypeParameter": true
-									}
-								],
-								"name": "PromiseSettledResult",
-								"package": "typescript"
-							}
-						}
-					],
-					"type": {
-						"type": "predicate",
-						"name": "val",
-						"asserts": false,
-						"targetType": {
-							"type": "reference",
-							"target": {
-								"sourceFileName": "../../node_modules/typescript/lib/lib.es2020.promise.d.ts",
-								"qualifiedName": "PromiseFulfilledResult"
-							},
-							"typeArguments": [
-								{
-									"type": "reference",
-									"target": -1,
-									"name": "T",
-									"refersToTypeParameter": true
-								}
-							],
-							"name": "PromiseFulfilledResult",
-							"package": "typescript"
-						}
-					}
-				}
-			]
-		},
-		{
-			"id": 5,
-			"name": "fulfilledValues",
-			"variant": "declaration",
-			"kind": 64,
-			"flags": {},
-			"sources": [
-				{
-					"fileName": "fulfilledValues.ts",
-					"line": 19,
-					"character": 13,
-					"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/fulfilledValues.ts#L19"
-				}
-			],
-			"signatures": [
-				{
-					"id": 6,
-					"name": "fulfilledValues",
-					"variant": "signature",
-					"kind": 4096,
-					"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": []
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "fulfilledValues.ts",
-							"line": 19,
-							"character": 31,
-							"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/fulfilledValues.ts#L19"
-						}
-					],
-					"typeParameter": [
-						{
-							"id": 7,
-							"name": "T",
-							"variant": "typeParam",
-							"kind": 131072,
-							"flags": {}
-						}
-					],
-					"parameters": [
-						{
-							"id": 8,
-							"name": "previousValue",
-							"variant": "param",
-							"kind": 32768,
-							"flags": {},
-							"type": {
-								"type": "array",
-								"elementType": {
-									"type": "reference",
-									"target": -1,
-									"name": "T",
-									"refersToTypeParameter": true
-								}
-							}
-						},
-						{
-							"id": 9,
-							"name": "currentValue",
-							"variant": "param",
-							"kind": 32768,
-							"flags": {},
-							"type": {
-								"type": "reference",
-								"target": {
-									"sourceFileName": "../../node_modules/typescript/lib/lib.es2020.promise.d.ts",
-									"qualifiedName": "PromiseSettledResult"
-								},
-								"typeArguments": [
-									{
-										"type": "reference",
-										"target": -1,
-										"name": "T",
-										"refersToTypeParameter": true
-									}
-								],
-								"name": "PromiseSettledResult",
-								"package": "typescript"
-							}
-						}
-					],
-					"type": {
-						"type": "array",
-						"elementType": {
-							"type": "reference",
-							"target": -1,
-							"name": "T",
-							"refersToTypeParameter": true
-						}
-					}
-				}
-			]
-		},
-		{
-			"id": 10,
-			"name": "rejected",
-			"variant": "declaration",
-			"kind": 64,
-			"flags": {},
-			"sources": [
-				{
-					"fileName": "rejected.ts",
-					"line": 6,
-					"character": 13,
-					"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/rejected.ts#L6"
-				}
-			],
-			"signatures": [
-				{
-					"id": 11,
-					"name": "rejected",
-					"variant": "signature",
-					"kind": 4096,
-					"flags": {},
-					"comment": {
-						"summary": [
-							{
-								"kind": "text",
-								"text": "For use with Promise.allSettled to filter only rejected results"
-							}
-						],
-						"blockTags": [
-							{
-								"tag": "@returns",
-								"content": []
-							}
-						]
-					},
-					"sources": [
-						{
-							"fileName": "rejected.ts",
-							"line": 6,
-							"character": 24,
-							"url": "https://github.com/xylabs/sdk-js/blob/88ada5a/packages/promise/src/rejected.ts#L6"
-						}
-					],
-					"typeParameter": [
-						{
-							"id": 12,
-							"name": "T",
-							"variant": "typeParam",
-							"kind": 131072,
-							"flags": {}
-						}
-					],
-					"parameters": [
-						{
-							"id": 13,
-							"name": "val",
-							"variant": "param",
-							"kind": 32768,
-							"flags": {},
-							"type": {
-								"type": "reference",
-								"target": {
-									"sourceFileName": "../../node_modules/typescript/lib/lib.es2020.promise.d.ts",
-									"qualifiedName": "PromiseSettledResult"
-								},
-								"typeArguments": [
-									{
-										"type": "reference",
-										"target": -1,
-										"name": "T",
-										"refersToTypeParameter": true
-									}
-								],
-								"name": "PromiseSettledResult",
-								"package": "typescript"
-							}
-						}
-					],
-					"type": {
-						"type": "predicate",
-						"name": "val",
-						"asserts": false,
-						"targetType": {
-							"type": "reference",
-							"target": {
-								"sourceFileName": "../../node_modules/typescript/lib/lib.es2020.promise.d.ts",
-								"qualifiedName": "PromiseRejectedResult"
-							},
-							"name": "PromiseRejectedResult",
-							"package": "typescript"
-						}
-					}
-				}
-			]
-		}
-	],
-	"groups": [
-		{
-			"title": "Functions",
-			"children": [
-				1,
-				5,
-				10
-			]
-		}
-	],
-	"packageName": "@xylabs/promise",
-	"readme": [
-		{
-			"kind": "text",
-			"text": "[![logo][]](https://xylabs.com)\n\n# @xylabs/sdk-js\n\n[![main-build][]][main-build-link]\n[![beta-build][]][beta-build-link]\n[![npm-badge][]][npm-link]\n[![bch-badge][]][bch-link]\n[![codacy-badge][]][codacy-link]\n[![codeclimate-badge][]][codeclimate-link]\n[![snyk-badge][]][snyk-link]\n\n## Table of Contents\n\n-   [Description](#description)\n-   [Install](#install)\n-   [Scripts](#scripts)\n-   [Maintainers](#maintainers)\n-   [License](#license)\n-   [Credits](#credits)\n\n## Description\n\nSDK for base code for Typescript and Javascript Libraries.\n\n## Install\n\nUsing npm:\n\n"
-		},
-		{
-			"kind": "code",
-			"text": "```sh\nnpm i --save @xylabs/sdk-js\n```"
-		},
-		{
-			"kind": "text",
-			"text": "\n\nUsing yarn:\n\n"
-		},
-		{
-			"kind": "code",
-			"text": "```sh\nyarn add @xylabs/sdk-js\n```"
-		},
-		{
-			"kind": "text",
-			"text": "\n\n## Scripts\n\nSee [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md)\nfor list of shared scripts.\n\n## Maintainers\n\n-   [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)\n\n## License\n\nSee the [LICENSE](LICENSE) file for license details\n\n## Credits\n\n[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)\n\n[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg\n[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg\n[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml\n[beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg\n[beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml\n[npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg\n[npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js\n[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main\n[bch-link]: https://bettercodehub.com/results/xylabs/sdk-js\n[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698\n[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade\n[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability\n[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability\n[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json\n[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json"
-		}
-	],
-	"symbolIdMap": {
-		"0": {
-			"sourceFileName": "src/index.ts",
-			"qualifiedName": ""
-		},
-		"1": {
-			"sourceFileName": "src/fulfilled.ts",
-			"qualifiedName": "fulfilled"
-		},
-		"2": {
-			"sourceFileName": "src/fulfilled.ts",
-			"qualifiedName": "fulfilled"
-		},
-		"3": {
-			"sourceFileName": "src/fulfilled.ts",
-			"qualifiedName": "T"
-		},
-		"4": {
-			"sourceFileName": "src/fulfilled.ts",
-			"qualifiedName": "val"
-		},
-		"5": {
-			"sourceFileName": "src/fulfilledValues.ts",
-			"qualifiedName": "fulfilledValues"
-		},
-		"6": {
-			"sourceFileName": "src/fulfilledValues.ts",
-			"qualifiedName": "fulfilledValues"
-		},
-		"7": {
-			"sourceFileName": "src/fulfilledValues.ts",
-			"qualifiedName": "T"
-		},
-		"8": {
-			"sourceFileName": "src/fulfilledValues.ts",
-			"qualifiedName": "previousValue"
-		},
-		"9": {
-			"sourceFileName": "src/fulfilledValues.ts",
-			"qualifiedName": "currentValue"
-		},
-		"10": {
-			"sourceFileName": "src/rejected.ts",
-			"qualifiedName": "rejected"
-		},
-		"11": {
-			"sourceFileName": "src/rejected.ts",
-			"qualifiedName": "rejected"
-		},
-		"12": {
-			"sourceFileName": "src/rejected.ts",
-			"qualifiedName": "T"
-		},
-		"13": {
-			"sourceFileName": "src/rejected.ts",
-			"qualifiedName": "val"
-		}
-	}
-}

package/dist/esm/fulfilled.js

@@ -1,9 +0,0 @@
-/**
- * For use with Promise.allSettled to filter only successful results
- * @param val
- * @returns
- */
-export const fulfilled = (val) => {
-    return val.status === 'fulfilled';
-};
-//# sourceMappingURL=fulfilled.js.map

package/dist/esm/fulfilled.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fulfilled.js","sourceRoot":"","sources":["../../src/fulfilled.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,GAA4B,EAAoC,EAAE;IAC7F,OAAO,GAAG,CAAC,MAAM,KAAK,WAAW,CAAA;AACnC,CAAC,CAAA"}

package/dist/esm/fulfilledValues.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fulfilledValues.js","sourceRoot":"","sources":["../../src/fulfilledValues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,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"}

package/dist/esm/index.js

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

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAA"}

package/dist/esm/rejected.js

@@ -1,9 +0,0 @@
-/**
- * For use with Promise.allSettled to filter only rejected results
- * @param val
- * @returns
- */
-export const rejected = (val) => {
-    return val.status === 'rejected';
-};
-//# sourceMappingURL=rejected.js.map

package/dist/esm/rejected.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"rejected.js","sourceRoot":"","sources":["../../src/rejected.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAI,GAA4B,EAAgC,EAAE;IACxF,OAAO,GAAG,CAAC,MAAM,KAAK,UAAU,CAAA;AAClC,CAAC,CAAA"}

package/dist/types/fulfilled.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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

package/dist/types/fulfilled.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fulfilled.d.ts","sourceRoot":"","sources":["../../src/fulfilled.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,SAAS,uEAErB,CAAA"}

package/dist/types/fulfilledValues.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fulfilledValues.d.ts","sourceRoot":"","sources":["../../src/fulfilledValues.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,eAAe,uEAG3B,CAAA"}

package/dist/types/index.d.ts

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

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErC,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAA"}

package/dist/types/rejected.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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

package/dist/types/rejected.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rejected.d.ts","sourceRoot":"","sources":["../../src/rejected.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,QAAQ,mEAEpB,CAAA"}

package/docs/assets/highlight.css

@@ -1,85 +0,0 @@
-:root {
-    --light-hl-0: #795E26;
-    --dark-hl-0: #DCDCAA;
-    --light-hl-1: #000000;
-    --dark-hl-1: #D4D4D4;
-    --light-hl-2: #A31515;
-    --dark-hl-2: #CE9178;
-    --light-hl-3: #0000FF;
-    --dark-hl-3: #569CD6;
-    --light-hl-4: #0070C1;
-    --dark-hl-4: #4FC1FF;
-    --light-hl-5: #267F99;
-    --dark-hl-5: #4EC9B0;
-    --light-hl-6: #AF00DB;
-    --dark-hl-6: #C586C0;
-    --light-hl-7: #001080;
-    --dark-hl-7: #9CDCFE;
-    --light-hl-8: #008000;
-    --dark-hl-8: #6A9955;
-    --light-code-background: #FFFFFF;
-    --dark-code-background: #1E1E1E;
-}
-
-@media (prefers-color-scheme: light) { :root {
-    --hl-0: var(--light-hl-0);
-    --hl-1: var(--light-hl-1);
-    --hl-2: var(--light-hl-2);
-    --hl-3: var(--light-hl-3);
-    --hl-4: var(--light-hl-4);
-    --hl-5: var(--light-hl-5);
-    --hl-6: var(--light-hl-6);
-    --hl-7: var(--light-hl-7);
-    --hl-8: var(--light-hl-8);
-    --code-background: var(--light-code-background);
-} }
-
-@media (prefers-color-scheme: dark) { :root {
-    --hl-0: var(--dark-hl-0);
-    --hl-1: var(--dark-hl-1);
-    --hl-2: var(--dark-hl-2);
-    --hl-3: var(--dark-hl-3);
-    --hl-4: var(--dark-hl-4);
-    --hl-5: var(--dark-hl-5);
-    --hl-6: var(--dark-hl-6);
-    --hl-7: var(--dark-hl-7);
-    --hl-8: var(--dark-hl-8);
-    --code-background: var(--dark-code-background);
-} }
-
-:root[data-theme='light'] {
-    --hl-0: var(--light-hl-0);
-    --hl-1: var(--light-hl-1);
-    --hl-2: var(--light-hl-2);
-    --hl-3: var(--light-hl-3);
-    --hl-4: var(--light-hl-4);
-    --hl-5: var(--light-hl-5);
-    --hl-6: var(--light-hl-6);
-    --hl-7: var(--light-hl-7);
-    --hl-8: var(--light-hl-8);
-    --code-background: var(--light-code-background);
-}
-
-:root[data-theme='dark'] {
-    --hl-0: var(--dark-hl-0);
-    --hl-1: var(--dark-hl-1);
-    --hl-2: var(--dark-hl-2);
-    --hl-3: var(--dark-hl-3);
-    --hl-4: var(--dark-hl-4);
-    --hl-5: var(--dark-hl-5);
-    --hl-6: var(--dark-hl-6);
-    --hl-7: var(--dark-hl-7);
-    --hl-8: var(--dark-hl-8);
-    --code-background: var(--dark-code-background);
-}
-
-.hl-0 { color: var(--hl-0); }
-.hl-1 { color: var(--hl-1); }
-.hl-2 { color: var(--hl-2); }
-.hl-3 { color: var(--hl-3); }
-.hl-4 { color: var(--hl-4); }
-.hl-5 { color: var(--hl-5); }
-.hl-6 { color: var(--hl-6); }
-.hl-7 { color: var(--hl-7); }
-.hl-8 { color: var(--hl-8); }
-pre, code { background: var(--code-background); }