Add promise package with defer (#18)

packages/date/README.md

@@ -1,4 +1,4 @@
-# @kanziwdate/
+# @kanziw/date
 
 [![npm version](https://img.shields.io/npm/v/@kanziw/date)](https://www.npmjs.com/package/@kanziw/date)
 [![license](https://img.shields.io/npm/l/@kanziw/date)](https://www.npmjs.com/package/@kanziw/date)

packages/date/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kanziw/date",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A collection of utility libraries about date",
   "repository": {
     "type": "git",

packages/promise/.npmignore

@@ -0,0 +1,3 @@
+src/
+**/__tests__/
+tsconfig.json

packages/promise/README.md

@@ -0,0 +1,51 @@
+# @kanziw/promise
+
+[![npm version](https://img.shields.io/npm/v/@kanziw/promise)](https://www.npmjs.com/package/@kanziw/promise)
+[![license](https://img.shields.io/npm/l/@kanziw/promise)](https://www.npmjs.com/package/@kanziw/promise)
+[![npm downloads](https://img.shields.io/npm/dt/@kanziw/promise)](https://www.npmjs.com/package/@kanziw/promise)
+
+
+## defer
+
+Handle promise resolve/reject manually.
+
+```ts
+import { defer } from '@kanziw/promise'
+
+async function rollbackableInsert() {
+  const commitOrRollback = defer<void>()
+  const insertedId = defer<string>()
+
+  const txPromise = db.withTransaction(async conn => {
+    const { insertId } = await conn.execute(qb.insertInto('table').values({}))
+      .then(insertedId.resolve)
+      .catch(err => {
+        insertedId.reject(err)
+        throw err
+      });
+
+    await commitOrRollback.promise
+  })
+
+  const commit = async () => {
+    commitOrRollback.resolve()
+    return txPromise
+  };
+
+  return {
+    insertId: await insertedId.promise,
+    commit,
+    rollback: deferWaitTransaction.reject,
+  }
+}
+
+const { insertId, commit, rollback } = await rollbackableInsert()
+
+try {
+  // some business logic
+  await commit()
+} catch (err) {
+  await rollback()
+  throw err
+}
+```

packages/promise/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@kanziw/promise",
+  "version": "0.1.0",
+  "description": "A collection of utility libraries about promise",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kanziw/kanziwjs.git",
+    "directory": "packages/promise"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/kanziw/kanziwjs/tree/main/packages/promise#readme",
+  "keywords": [
+    "promise",
+    "kanziw",
+    "defer"
+  ],
+  "author": {
+    "name": "Jiwoong Jung",
+    "email": "kanziwoong@gmail.com"
+  },
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "packageManager": "yarn@3.2.0",
+  "scripts": {
+    "lint": "yarn workspace kanziwjs eslint packages/promise",
+    "test": "yarn workspace kanziwjs test packages/promise",
+    "clean": "rimraf lib",
+    "build": "yarn clean && yarn tsc",
+    "publish": "yarn build && yarn publish-if-not-published"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.5.0",
+    "@types/node": "^17.0.25",
+    "publish-if-not-published": "^3.1.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.6.3"
+  },
+  "license": "MIT"
+}

packages/promise/src/__tests__/defer.spec.ts

@@ -0,0 +1,44 @@
+import { setTimeout as delay } from 'timers/promises'
+
+import { defer } from '../defer'
+
+describe('defer', () => {
+  it('success w/ resolve', async() => {
+    const { deferWait, checkDeferWaitStatus } = deferTester()
+
+    const beforeResolveResult = await checkDeferWaitStatus()
+    expect(beforeResolveResult).toEqual('pending')
+
+    deferWait.resolve()
+    const afterResolveResult = await checkDeferWaitStatus()
+    expect(afterResolveResult).toEqual('resolved')
+  })
+
+  it('success w/ reject', async() => {
+    const { deferWait, checkDeferWaitStatus } = deferTester()
+
+    const beforeRejectResult = await checkDeferWaitStatus()
+    expect(beforeRejectResult).toEqual('pending')
+
+    deferWait.reject()
+    const afterRejectResult = await checkDeferWaitStatus()
+    expect(afterRejectResult).toEqual('rejected')
+  })
+})
+
+function deferTester() {
+  const deferWait = defer()
+  const checkDeferWaitStatus = async() => (
+    Promise.race([
+      delay(10).then(() => 'pending'),
+      deferWait.promise
+        .then(() => 'resolved')
+        .catch(() => 'rejected'),
+    ])
+  )
+
+  return {
+    deferWait,
+    checkDeferWaitStatus,
+  }
+}

packages/promise/src/defer.ts

@@ -0,0 +1,17 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-empty-function */
+
+export const defer = <T=void>() => {
+  const defer = {
+    promise: Promise.resolve(undefined as unknown as T),
+    resolve: (_value: T | PromiseLike<T>) => {},
+    reject: (_reason?: any) => {},
+  }
+  defer.promise = new Promise((resolve, reject) => {
+    defer.resolve = resolve
+    defer.reject = reject
+  })
+
+  return defer
+}

packages/promise/src/index.ts

@@ -0,0 +1 @@
+export * from './defer'

packages/promise/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib",
+  },
+  "include": [
+    "src"
+  ]
+}

yarn.lock

@@ -1998,6 +1998,18 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@kanziw/promise@workspace:packages/promise":
+  version: 0.0.0-use.local
+  resolution: "@kanziw/promise@workspace:packages/promise"
+  dependencies:
+    "@types/jest": ^27.5.0
+    "@types/node": ^17.0.25
+    publish-if-not-published: ^3.1.2
+    rimraf: ^3.0.2
+    typescript: ^4.6.3
+  languageName: unknown
+  linkType: soft
+
 "@kanziw/time@workspace:packages/time":
   version: 0.0.0-use.local
   resolution: "@kanziw/time@workspace:packages/time"