@xylabs/sdk-js 2.4.3 → 2.4.6

package/package.json

@@ -11,32 +11,32 @@
   },
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "devDependencies": {
-    "@babel/core": "7.17.8",
+    "@babel/core": "7.17.9",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-strip": "^2.1.0",
-    "@rollup/plugin-typescript": "^8.3.1",
+    "@rollup/plugin-typescript": "^8.3.2",
     "@types/bn.js": "^5.1.0",
     "@types/jest": "^27.4.1",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.22",
-    "@xylabs/eslint-config": "2.3.19",
-    "@xylabs/rollup-config": "^1.1.10",
-    "@xylabs/ts-scripts": "^1.0.48",
-    "@xylabs/tsconfig": "^1.0.12",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.25",
+    "@xylabs/eslint-config": "2.3.22",
+    "@xylabs/rollup-config": "^1.1.15",
+    "@xylabs/ts-scripts": "^1.0.53",
+    "@xylabs/tsconfig": "^1.0.13",
     "babel-jest": "^27.5.1",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.11.0",
+    "eslint": "^8.13.0",
     "jest": "^27.5.1",
     "npm-package-json-lint": "^6.3.0",
     "npm-package-json-lint-config-default": "^5.0.0",
-    "prettier": "^2.6.0",
+    "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
-    "rollup": "^2.70.1",
-    "ts-jest": "^27.1.3",
+    "rollup": "^2.70.2",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
-    "tslib": "^2.3.1",
-    "typescript": "^4.6.2"
+    "tslib": "^2.4.0",
+    "typescript": "^4.6.3"
   },
   "esm5": "dist/esm5/index.js",
   "exports": {
@@ -64,8 +64,8 @@
   "dependencies": {
     "axios": "^0.26.1",
     "bn.js": "^5.2.0",
-    "buffer": "^6.0.3",
-    "rollbar": "^2.24.1"
+    "rollbar": "^2.25.0",
+    "safe-buffer": "^5.2.1"
   },
   "publishConfig": {
     "access": "public"
@@ -84,6 +84,6 @@
   },
   "sideEffects": false,
   "types": "dist/index.d.ts",
-  "version": "2.4.3",
+  "version": "2.4.6",
   "packageManager": "yarn@3.1.1"
 }

package/src/bufferPolyfill.ts

@@ -1,6 +1,7 @@
-import { Buffer } from 'buffer'
+import { Buffer } from 'safe-buffer'
 
 //make sure we have a global Buffer object if in browser
+/** @deprecated use safe-buffer npm package instead */
 export const bufferPolyfill = () => {
   if (window !== undefined) {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/forget.spec.ts

@@ -0,0 +1,18 @@
+import { delay } from './delay'
+import { forget } from './forget'
+
+
+describe('foget', () => {
+  test('checking happy path', async () => {
+    let cancelled = false
+    forget(delay(100), {delay: 200, cancel: () => cancelled = true })
+    await delay(300)
+    expect(cancelled).toBeFalsy()
+  })
+  test('checking unhappy path', async () => {
+    let cancelled = false
+    forget(delay(200), {delay: 100, cancel: () => cancelled = true })
+    await delay(300)
+    expect(cancelled).toBeTruthy()
+  })
+})

package/src/forget.ts

@@ -1,12 +1,45 @@
+import { delay } from './delay'
+
+interface ForgetTimeoutConfig {
+  delay: number
+  cancel: () => void
+}
+
 //used to explicitly launch an async funtion (or Promise) with awaiting it
-const forget = (promise?: Promise<unknown>) => {
-  promise
-    ?.then(() => {
+export const forget = (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig) => {
+  let completed = false
+
+  const promiseWrapper = async () => {
+    await promise
+      .then(() => {
+        completed = true
+      })
+      .catch(() => {
+        completed = true
+      })
+  }
+
+  const promises = [promiseWrapper()]
+
+  //if there is a timeout, add it to the race
+  if (timeout) {
+    const timeoutFunc = async () => {
+      await delay(timeout.delay)
+      if (!completed) {
+        console.log(`forget promise timeout out after ${timeout.delay}ms [Cancelling]`)
+        timeout.cancel?.()
+      }
+    }
+    promises.push(timeoutFunc())
+  }
+
+  const all = Promise.race(promises)
+
+  all
+    .then(() => {
       return
     })
     .catch(() => {
       return
     })
 }
-
-export { forget }