@dxos/async 0.8.4-main.f9ba587 → 0.8.4-main.fcc0d83b33

package/src/timeout.ts

@@ -4,7 +4,6 @@
 
 import { type Context, ContextDisposedError } from '@dxos/context';
 
-import { createPromiseFromCallback } from './callback';
 import { TimeoutError } from './errors';
 
 /**
@@ -28,6 +27,27 @@ export const sleep = (ms: number) => {
   });
 };
 
+// TODO(burdon): Reconcile with sleep.
+export const sleepWithContext = (ctx: Context, ms: number) => {
+  const error = new ContextDisposedError();
+  return new Promise<void>((resolve, reject) => {
+    if (ctx.disposed) {
+      reject(error);
+      return;
+    }
+
+    const timeout = setTimeout(() => {
+      clearDispose();
+      resolve();
+    }, ms);
+
+    const clearDispose = ctx.onDispose(() => {
+      clearTimeout(timeout);
+      reject(error);
+    });
+  });
+};
+
 /**
  * Can be used in long-running tasks to let other callbacks be invoked.
  */
@@ -36,12 +56,11 @@ export const asyncReturn = () => sleep(0);
 /**
  * Wait for promise or throw error.
  */
-export const asyncTimeout = async <T>(
-  // TODO(dmaretskyi): This callback API is unintuitive and leads to bugs.
-  promise: Promise<T> | (() => Promise<T>),
-  timeout: number,
-  err?: Error | string,
-): Promise<T> => {
+export const asyncTimeout = async <T>(promise: Promise<T>, timeout: number, err?: Error | string): Promise<T> => {
+  if (typeof promise === 'function') {
+    throw new Error('First argument must be a promise.');
+  }
+
   let timeoutId: NodeJS.Timeout;
   const throwable = err === undefined || typeof err === 'string' ? new TimeoutError(timeout, err) : err;
   const timeoutPromise = new Promise<T>((resolve, reject) => {
@@ -52,8 +71,7 @@ export const asyncTimeout = async <T>(
     unrefTimeout(timeoutId);
   });
 
-  const conditionTimeout = typeof promise === 'function' ? createPromiseFromCallback<T>(promise) : promise;
-  return await Promise.race([conditionTimeout, timeoutPromise]).finally(() => {
+  return await Promise.race([promise, timeoutPromise]).finally(() => {
     clearTimeout(timeoutId);
   });
 };
@@ -67,23 +85,3 @@ export const unrefTimeout = (timeoutId: NodeJS.Timeout) => {
     timeoutId.unref();
   }
 };
-
-export const sleepWithContext = (ctx: Context, ms: number) => {
-  const error = new ContextDisposedError();
-  return new Promise<void>((resolve, reject) => {
-    if (ctx.disposed) {
-      reject(error);
-      return;
-    }
-
-    const timeout = setTimeout(() => {
-      clearDispose();
-      resolve();
-    }, ms);
-
-    const clearDispose = ctx.onDispose(() => {
-      clearTimeout(timeout);
-      reject(error);
-    });
-  });
-};

package/src/trigger.ts

@@ -2,6 +2,8 @@
 // Copyright 2020 DXOS.org
 //
 
+import { invariant } from '@dxos/invariant';
+
 import { TimeoutError } from './errors';
 import { asyncTimeout } from './timeout';
 
@@ -10,7 +12,7 @@ import { asyncTimeout } from './timeout';
  * @deprecated Use `Trigger` instead.
  */
 export const trigger = <T = void>(timeout?: number): [() => Promise<T>, (arg: T) => void] => {
-  // eslint-disable-line @stayradiated/prefer-arrow-functions/prefer-arrow-functions
+  // eslint-disable-line prefer-arrow-functions/prefer-arrow-functions
   let callback: (arg: T) => void;
 
   const promise = new Promise<T>((resolve, reject) => {
@@ -121,3 +123,58 @@ export class Trigger<T = void> {
     return this;
   }
 }
+
+type LatchProps = {
+  count?: number;
+  timeout?: number;
+};
+
+type LatchResult = [() => Promise<number>, () => number, (err: Error) => void];
+
+/**
+ * Returns a callback and a promise that's resolved when the callback is called n times.
+ * @deprecated Use `Trigger` instead.
+ */
+export const latch = ({ count = 1, timeout }: LatchProps = {}): LatchResult => {
+  invariant(count >= 0);
+
+  let t: ReturnType<typeof setTimeout>;
+  let doResolve: (value: number) => void;
+  let doReject: (err: Error) => void;
+  const promise = new Promise<number>((resolve, reject) => {
+    doResolve = (value) => {
+      clearTimeout(t);
+      resolve(value);
+    };
+
+    doReject = (err) => {
+      clearTimeout(t);
+      reject(err);
+    };
+  });
+
+  if (count === 0) {
+    setTimeout(() => {
+      doResolve(0);
+    });
+  } else {
+    if (timeout) {
+      t = setTimeout(() => {
+        doReject(new Error(`Timed out after ${timeout.toLocaleString()}ms`));
+      }, timeout);
+    }
+  }
+
+  let i = 0;
+  return [
+    async () => await promise,
+    () => {
+      if (++i === count) {
+        doResolve(i);
+      }
+
+      return i;
+    },
+    (err: Error) => doReject(err),
+  ];
+};

package/src/update-scheduler.ts

@@ -16,7 +16,7 @@ export type UpdateSchedulerOptions = {
 /**
  * Time period for update counting.
  */
-const TIME_PERIOD = 1000;
+const TIME_PERIOD = 1_000;
 
 export class UpdateScheduler {
   /**

package/dist/types/src/latch.d.ts

@@ -1,11 +0,0 @@
-type LatchProps = {
-    count?: number;
-    timeout?: number;
-};
-type LatchResult = [() => Promise<number>, () => number, (err: Error) => void];
-/**
- * Returns a callback and a promise that's resolved when the callback is called n times.
- */
-export declare const latch: ({ count, timeout }?: LatchProps) => LatchResult;
-export {};
-//# sourceMappingURL=latch.d.ts.map

package/dist/types/src/latch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"latch.d.ts","sourceRoot":"","sources":["../../../src/latch.ts"],"names":[],"mappings":"AAMA,KAAK,UAAU,GAAG;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,KAAK,WAAW,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC;AAE/E;;GAEG;AAEH,eAAO,MAAM,KAAK,GAAI,qBAAwB,UAAe,KAAG,WA0C/D,CAAC"}

package/dist/types/src/sink.d.ts

@@ -1,6 +0,0 @@
-import { type EventEmitter } from 'node:events';
-/**
- * Waits for the specified number of events from the given emitter.
- */
-export declare const sink: (emitter: EventEmitter, event: string, count?: number) => Promise<void>;
-//# sourceMappingURL=sink.d.ts.map

package/dist/types/src/sink.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sink.d.ts","sourceRoot":"","sources":["../../../src/sink.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,aAAa,CAAC;AAIhD;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,SAAS,YAAY,EAAE,OAAO,MAAM,EAAE,cAAS,KAAG,OAAO,CAAC,IAAI,CAclF,CAAC"}

package/dist/types/src/throttle.d.ts

@@ -1,2 +0,0 @@
-export declare const throttle: (cb: (...args: any[]) => void, wait?: number) => ((...args: any[]) => void);
-//# sourceMappingURL=throttle.d.ts.map

package/dist/types/src/throttle.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../../../src/throttle.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,QAAQ,GAAI,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,aAAU,KAAG,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAS5F,CAAC"}

package/dist/types/src/throttle.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=throttle.test.d.ts.map

package/dist/types/src/throttle.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"throttle.test.d.ts","sourceRoot":"","sources":["../../../src/throttle.test.ts"],"names":[],"mappings":""}

package/dist/types/src/types.d.ts

@@ -1,2 +0,0 @@
-export type Awaited<T> = T extends Promise<infer U> ? U : T;
-//# sourceMappingURL=types.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC"}

package/dist/types/src/until.d.ts

@@ -1,14 +0,0 @@
-export type UntilCallback<T> = (resolve: (value: T) => void, reject: (error: Error) => void) => Promise<T> | void;
-/**
- * Awaits promise.
- */
-export declare const until: <T = void>(cb: UntilCallback<T>, timeout?: number) => Promise<T>;
-/**
- * Wait until promise resolves.
- */
-export declare const untilPromise: <T = void>(cb: () => Promise<T>) => Promise<T>;
-/**
- * Wait until error is thrown.
- */
-export declare const untilError: (cb: () => Promise<any>) => Promise<unknown>;
-//# sourceMappingURL=until.d.ts.map

package/dist/types/src/until.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"until.d.ts","sourceRoot":"","sources":["../../../src/until.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AAElH;;GAEG;AAEH,eAAO,MAAM,KAAK,GAAI,CAAC,GAAG,IAAI,EAAE,IAAI,aAAa,CAAC,CAAC,CAAC,EAAE,UAAU,MAAM,KAAG,OAAO,CAAC,CAAC,CAyBjF,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,YAAY,GAAI,CAAC,GAAG,IAAI,EAAE,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,eAAS,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,UAAU,GAAI,IAAI,MAAM,OAAO,CAAC,GAAG,CAAC,qBAWhD,CAAC"}

package/dist/types/src/until.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=until.test.d.ts.map

package/dist/types/src/until.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"until.test.d.ts","sourceRoot":"","sources":["../../../src/until.test.ts"],"names":[],"mappings":""}

package/src/latch.ts

@@ -1,60 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-import { invariant } from '@dxos/invariant';
-
-type LatchProps = {
-  count?: number;
-  timeout?: number;
-};
-
-type LatchResult = [() => Promise<number>, () => number, (err: Error) => void];
-
-/**
- * Returns a callback and a promise that's resolved when the callback is called n times.
- */
-// TODO(burdon): Reconcile with until/trigger.
-export const latch = ({ count = 1, timeout }: LatchProps = {}): LatchResult => {
-  invariant(count >= 0);
-
-  let t: ReturnType<typeof setTimeout>;
-  let doResolve: (value: number) => void;
-  let doReject: (err: Error) => void;
-  const promise = new Promise<number>((resolve, reject) => {
-    doResolve = (value) => {
-      clearTimeout(t);
-      resolve(value);
-    };
-
-    doReject = (err) => {
-      clearTimeout(t);
-      reject(err);
-    };
-  });
-
-  if (count === 0) {
-    setTimeout(() => {
-      doResolve(0);
-    });
-  } else {
-    if (timeout) {
-      t = setTimeout(() => {
-        doReject(new Error(`Timed out after ${timeout.toLocaleString()}ms`));
-      }, timeout);
-    }
-  }
-
-  let i = 0;
-  return [
-    async () => await promise,
-    () => {
-      if (++i === count) {
-        doResolve(i);
-      }
-
-      return i;
-    },
-    (err: Error) => doReject(err),
-  ];
-};

package/src/sink.ts

@@ -1,26 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-import { type EventEmitter } from 'node:events';
-
-import { trigger } from './trigger';
-
-/**
- * Waits for the specified number of events from the given emitter.
- */
-export const sink = (emitter: EventEmitter, event: string, count = 1): Promise<void> => {
-  const [getPromise, resolve] = trigger();
-
-  let counter = 0;
-  const listener = () => {
-    if (++counter === count) {
-      emitter.off(event, listener);
-      resolve();
-    }
-  };
-
-  emitter.on(event, listener);
-
-  return getPromise();
-};

package/src/throttle.test.ts

@@ -1,65 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-import { describe, expect, test } from 'vitest';
-
-import { throttle } from './throttle';
-import { sleep } from './timeout';
-
-describe('throttle', () => {
-  test('throttles function calls', async () => {
-    let count = 0;
-    const fn = throttle(() => count++, 100);
-
-    // First call should execute immediately
-    fn();
-    expect(count).toBe(1);
-
-    // Second call within throttle window should not execute
-    fn();
-    expect(count).toBe(1);
-
-    // Wait for throttle window to pass
-    await sleep(150);
-
-    // Next call should execute
-    fn();
-    expect(count).toBe(2);
-  });
-
-  test('passes arguments to throttled function', async () => {
-    let lastArgs: any[] = [];
-    const fn = throttle((...args: any[]) => {
-      lastArgs = args;
-    }, 100);
-
-    fn('test', 123);
-    expect(lastArgs).toEqual(['test', 123]);
-
-    // Call with different args within throttle window
-    fn('different', 456);
-    expect(lastArgs).toEqual(['test', 123]); // Should not update
-
-    await sleep(150);
-    fn('new', 789);
-    expect(lastArgs).toEqual(['new', 789]);
-  });
-
-  test('handles multiple rapid calls', async () => {
-    let count = 0;
-    const fn = throttle(() => count++, 100);
-
-    // Make multiple rapid calls
-    for (let i = 0; i < 5; i++) {
-      fn();
-    }
-    expect(count).toBe(1); // Only first call should execute
-
-    await sleep(150);
-    expect(count).toBe(1); // Still only one execution
-
-    fn();
-    expect(count).toBe(2); // Next call after wait should execute
-  });
-});

package/src/throttle.ts

@@ -1,14 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export const throttle = (cb: (...args: any[]) => void, wait = 100): ((...args: any[]) => void) => {
-  let lastCall = 0;
-  return (...args: any[]) => {
-    const now = Date.now();
-    if (now - lastCall >= wait) {
-      cb(...args);
-      lastCall = now;
-    }
-  };
-};

package/src/types.ts

@@ -1,5 +0,0 @@
-//
-// Copyright 2021 DXOS.org
-//
-
-export type Awaited<T> = T extends Promise<infer U> ? U : T;

package/src/until.test.ts

@@ -1,47 +0,0 @@
-//
-// Copyright 2020 DXOS.org
-//
-
-import { describe, expect, test } from 'vitest';
-
-import { sleep } from './timeout';
-import { until } from './until';
-
-describe('until', () => {
-  test('success', async () => {
-    const value = await until<number>(async (resolve) => {
-      await sleep(100);
-      resolve(100);
-      return 1;
-    });
-
-    expect(value).to.equal(100);
-  });
-
-  test('error', async () => {
-    await expect(async () => {
-      await until(async (resolve, reject) => {
-        await sleep(100);
-        reject(new Error());
-      });
-    }).rejects.toThrowError();
-  });
-
-  test('catch', async () => {
-    await expect(async () => {
-      await until(async () => {
-        await sleep(100);
-        throw new Error();
-      });
-    }).rejects.toThrowError();
-  });
-
-  test('timeout', async () => {
-    await expect(async () => {
-      await until(async (resolve) => {
-        await sleep(500);
-        resolve();
-      }, 100); // Timeout before complete.
-    }).rejects.toThrowError();
-  });
-});

package/src/until.ts

@@ -1,58 +0,0 @@
-//
-// Copyright 2022 DXOS.org
-//
-
-export type UntilCallback<T> = (resolve: (value: T) => void, reject: (error: Error) => void) => Promise<T> | void;
-
-/**
- * Awaits promise.
- */
-// TODO(burdon): Reconcile with latch/trigger.
-export const until = <T = void>(cb: UntilCallback<T>, timeout?: number): Promise<T> => {
-  return new Promise((resolve, reject) => {
-    const t =
-      timeout &&
-      setTimeout(() => {
-        reject(new Error(`Timeout after ${t}ms`));
-      }, timeout);
-
-    setTimeout(async () => {
-      try {
-        await cb(
-          (value: T) => {
-            t && clearTimeout(t);
-            resolve(value);
-          },
-          (error: Error) => {
-            t && clearTimeout(t);
-            reject(error);
-          },
-        );
-      } catch (err) {
-        reject(err);
-      }
-    });
-  });
-};
-
-/**
- * Wait until promise resolves.
- */
-// TODO(burdon): Reconcile promises (with timeouts).
-export const untilPromise = <T = void>(cb: () => Promise<T>) => cb();
-
-/**
- * Wait until error is thrown.
- */
-export const untilError = (cb: () => Promise<any>) => {
-  return new Promise((resolve, reject) => {
-    setTimeout(async () => {
-      try {
-        await cb();
-        reject(new Error('No error was thrown.'));
-      } catch (err) {
-        resolve(err);
-      }
-    });
-  });
-};