feat(async): add aResolvers promise util

Author: Thanga-Ganapathy

.changeset/silver-experts-hug.md

@@ -0,0 +1,5 @@
+---
+"@opentf/std": minor
+---
+
+Added aResolvers aync utils.

README.md

@@ -63,6 +63,9 @@ Let’s explore some of the library’s capabilities:
 import { isNum } from "@opentf/std";
 
 isNum(NaN); //=> false
+isNum("1"); //=> false
+isNum("1", true); //=> true
+isNum(1); //=> true
 ```
 
 2. Converting Strings to Pascal Case:
@@ -136,6 +139,18 @@ compose(
 ); //=> 6
 ```
 
+8. Pick & Omit Paths in an Object
+
+```js
+import { pick omit } from '@opentf/std';
+
+const obj = { a: 1, b: 2, c: 3 };
+
+pick(obj, 'a', 'c'); //=> { a: 1, c: 3 }
+
+omit(obj, 'a', 'c'); //=> { b: 2 }
+```
+
 ## API
 
 ### Array
@@ -175,6 +190,7 @@ compose(
 - [aMap](https://js-std.pages.dev/Async/aMap)
 - [aPipe](https://js-std.pages.dev/Async/aPipe)
 - [aPipeFn](https://js-std.pages.dev/Async/aPipeFn)
+- [aResolvers](https://js-std.pages.dev/Async/aResolvers)
 
 ### Maths
 

apps/docs/pages/Async/_meta.json

@@ -5,5 +5,6 @@
   "aForEach": "aForEach",
   "aMap": "aMap",
   "aPipe": "aPipe",
-  "aPipeFn": "aPipeFn"
+  "aPipeFn": "aPipeFn",
+  "aResolvers": "aResolvers"
 }

apps/docs/pages/Async/aResolvers.mdx

@@ -0,0 +1,39 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Creates a promise with custom resolvers for `resolve` and `reject`.
+
+<Callout type="default">
+This is same as the new static method `Promise.withResolvers()`.
+</Callout>
+
+## Syntax
+
+```ts
+import { aResolvers } from '@opentf/std';
+
+const { promise, resolve, reject } = aResolvers();
+```
+
+## Examples
+
+```ts
+const { promise, resolve, reject } = aResolvers()
+
+Math.random() > 0.5 ? resolve(console.log("ok")) : reject("not ok");
+```
+
+## Try
+
+<REPL code={`const { aResolvers } = require('@opentf/std');
+
+const { promise, resolve, reject } = aResolvers()
+
+Math.random() > 0.5 ? resolve(console.log("ok")) : reject("not ok");
+`} />
+
+### Resources
+
+- [tc39/proposal-promise-with-resolvers](https://github.com/tc39/proposal-promise-with-resolvers)
+
+- [Promise.withResolvers()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers)

package.json

@@ -20,8 +20,7 @@
   ],
   "lint-staged": {
     "*.{ts,tsx}": [
-      "pnpm run format",
-      "pnpm run lint --"
+      "pnpm run format"
     ],
     "*.json": [
       "npm run format"

packages/std/README.md

@@ -63,6 +63,9 @@ Let’s explore some of the library’s capabilities:
 import { isNum } from "@opentf/std";
 
 isNum(NaN); //=> false
+isNum('1'); //=> false
+isNum('1', true); //=> true
+isNum(1); //=> true
 ```
 
 2. Converting Strings to Pascal Case:
@@ -136,6 +139,18 @@ compose(
 ); //=> 6
 ```
 
+8. Pick & Omit Paths in an Object
+
+```js
+import { pick omit } from '@opentf/std';
+ 
+const obj = { a: 1, b: 2, c: 3 };
+ 
+pick(obj, 'a', 'c'); //=> { a: 1, c: 3 }
+ 
+omit(obj, 'a', 'c'); //=> { b: 2 }
+```
+
 ## API
 
 ### Array
@@ -175,6 +190,7 @@ compose(
 - [aMap](https://js-std.pages.dev/Async/aMap)
 - [aPipe](https://js-std.pages.dev/Async/aPipe)
 - [aPipeFn](https://js-std.pages.dev/Async/aPipeFn)
+- [aResolvers](https://js-std.pages.dev/Async/aResolvers)
 
 ### Maths
 

packages/std/__tests__/async/aResolvers.spec.ts

@@ -0,0 +1,16 @@
+import { aResolvers } from '../../src';
+
+describe('Async > aResolvers', () => {
+  test('resolve', async () => {
+    const { promise, resolve, reject } = aResolvers();
+    resolve('fulfilled');
+    await expect(promise).resolves.toBe('fulfilled');
+  });
+
+  test('reject', async () => {
+    const { promise, resolve, reject } = aResolvers();
+
+    reject(new Error('Rejected'));
+    await expect(promise).rejects.toThrow('Rejected');
+  });
+});

packages/std/package.json

@@ -77,19 +77,19 @@
   },
   "devDependencies": {
     "@opentf/eslint-config-base": "^0.2.0",
-    "@swc/core": "^1.4.0",
+    "@swc/core": "^1.6.13",
     "@swc/jest": "^0.2.24",
     "@types/jest": "^29.5.1",
-    "@types/node": "^20.12.5",
-    "@typescript-eslint/eslint-plugin": "^7.6.0",
-    "@typescript-eslint/parser": "^7.6.0",
+    "@types/node": "^20.14.10",
+    "@typescript-eslint/eslint-plugin": "^7.16.0",
+    "@typescript-eslint/parser": "^7.16.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-jest": "^28.2.0",
+    "eslint-plugin-jest": "^28.6.0",
     "eslint-plugin-prettier": "^5.1.3",
     "jest": "^29.7.0",
-    "prettier": "^3.2.5",
-    "tsup": "^8.0.1",
-    "typescript": "^5.4.3"
+    "prettier": "^3.3.2",
+    "tsup": "^8.1.0",
+    "typescript": "^5.5.3"
   }
 }

packages/std/src/async/aResolvers.ts

@@ -0,0 +1,23 @@
+/**
+ * Creates a promise with custom resolvers for `resolve` and `reject`.
+ *
+ * @example
+ * const { promise, resolve, reject } = Promise.withResolvers();
+ * Math.random() > 0.5 ? resolve("ok") : reject("not ok");
+ */
+
+export default function aResolvers<T>(): {
+  promise: Promise<T>;
+  resolve: (value: T) => void;
+  reject: (reason?: unknown) => void;
+} {
+  let resolve: (value: T) => void;
+  let reject: (reason?: unknown) => void;
+  const promise = new Promise<T>((res, rej) => {
+    resolve = res;
+    reject = rej;
+  });
+
+  //@ts-expect-error Ignore errors
+  return { promise, resolve, reject };
+}

packages/std/src/index.ts

@@ -42,6 +42,7 @@ export { default as aPipe } from './async/aPipe';
 export { default as aPipeFn } from './async/aPipeFn';
 export { default as aCompose } from './async/aCompose';
 export { default as aComposeFn } from './async/aComposeFn';
+export { default as aResolvers } from './async/aResolvers';
 
 // Maths
 export { default as percentage } from './maths/percentage';