@dxos/util 0.3.11-next.e28df4f → 0.3.11-next.f4c1077

package/dist/types/src/safe-parse-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safe-parse-json.d.ts","sourceRoot":"","sources":["../../../src/safe-parse-json.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,aAAa,EAAE;IAC1B,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,SAAS,CAAC;CAQpE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/util",
-  "version": "0.3.11-next.e28df4f",
+  "version": "0.3.11-next.f4c1077",
   "description": "Temporary bucket for misc functions, which should graduate into separate packages.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -16,13 +16,13 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/debug": "0.3.11-next.e28df4f",
-    "@dxos/invariant": "0.3.11-next.e28df4f",
-    "@dxos/keys": "0.3.11-next.e28df4f",
-    "@dxos/node-std": "0.3.11-next.e28df4f"
+    "@dxos/keys": "0.3.11-next.f4c1077",
+    "@dxos/invariant": "0.3.11-next.f4c1077",
+    "@dxos/debug": "0.3.11-next.f4c1077",
+    "@dxos/node-std": "0.3.11-next.f4c1077"
   },
   "devDependencies": {
-    "@dxos/crypto": "0.3.11-next.e28df4f"
+    "@dxos/crypto": "0.3.11-next.f4c1077"
   },
   "publishConfig": {
     "access": "public"

package/src/defer.test.ts

@@ -0,0 +1,37 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { expect } from 'chai';
+
+import { describe, test } from '@dxos/test';
+
+import { defer, deferAsync } from './defer';
+
+describe('defer', () => {
+  test('defer', () => {
+    const events: string[] = [];
+
+    {
+      using _ = defer(() => events.push('1'));
+      events.push('2');
+    }
+
+    expect(events).to.deep.eq(['2', '1']);
+  });
+
+  test('deferAsync', async () => {
+    const events: string[] = [];
+
+    {
+      await using _ = deferAsync(async () => {
+        await new Promise((resolve) => setTimeout(resolve, 5));
+        events.push('1');
+      });
+      events.push('2');
+    }
+    events.push('3');
+
+    expect(events).to.deep.eq(['2', '1', '3']);
+  });
+});

package/src/defer.ts

@@ -0,0 +1,54 @@
+/**
+ * Run function on scope exit.
+ *
+ * @example
+ * ```ts
+ * {
+ *   using _ = defer(() => console.log('exiting'));
+ *
+ *   ...
+ * }
+ */
+//
+// Copyright 2024 DXOS.org
+//
+
+export const defer = (fn: () => void): Disposable => new DeferGuard(fn);
+
+class DeferGuard {
+  /**
+   * @internal
+   */
+  constructor(private readonly _fn: () => void) {}
+
+  [Symbol.dispose]() {
+    const result = this._fn();
+    if ((result as any) instanceof Promise) {
+      throw new Error('Async functions in defer are not supported. Use deferAsync instead.');
+    }
+  }
+}
+
+/**
+ * Run async function on scope exit.
+ *
+ * @example
+ * ```ts
+ * {
+ *   await using _ = deferAsync(async () => console.log('exiting'));
+ *
+ *   ...
+ * }
+ */
+export const deferAsync = (fn: () => Promise<void>): AsyncDisposable => new DeferAsyncGuard(fn);
+
+class DeferAsyncGuard implements AsyncDisposable {
+  /**
+   * @internal
+   */
+  constructor(private readonly _fn: () => Promise<void>) {}
+
+  async [Symbol.asyncDispose]() {
+    await this._fn();
+  }
+}

package/src/index.ts

@@ -18,6 +18,7 @@ export * from './random';
 export * from './range';
 export * from './reducers';
 export * from './safe-instanceof';
+export * from './safe-parse-json';
 export * from './sort';
 export * from './tracer';
 export * from './types';
@@ -27,3 +28,4 @@ export * from './sum';
 export * from './for-each-async';
 export * from './weak';
 export * from './map-values';
+export * from './defer';

package/src/safe-parse-json.ts

@@ -0,0 +1,15 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+export const safeParseJson: {
+  <T extends object>(data: string | undefined | null, defaultValue: T): T;
+  <T extends object>(data: string | undefined | null): T | undefined;
+} = <T extends object>(data: string | undefined | null, defaultValue?: T) => {
+  if (data) {
+    try {
+      return JSON.parse(data);
+    } catch (err) {}
+  }
+  return defaultValue;
+};