@fluidframework/test-utils 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.0

package/src/timeoutUtils.ts

@@ -6,6 +6,9 @@
 import { assert, Deferred } from "@fluidframework/core-utils";
 
 // @deprecated this value is no longer used
+/**
+ * @internal
+ */
 export const defaultTimeoutDurationMs = 250;
 
 const timeBuffer = 15; // leave 15 ms leeway for finish processing
@@ -100,6 +103,9 @@ if (globalThis.getMochaModule !== undefined) {
 	};
 }
 
+/**
+ * @internal
+ */
 export interface TimeoutWithError {
 	/**
 	 * Timeout duration in milliseconds, if it is great than 0 and not Infinity
@@ -110,6 +116,9 @@ export interface TimeoutWithError {
 	reject?: true;
 	errorMsg?: string;
 }
+/**
+ * @internal
+ */
 export interface TimeoutWithValue<T = void> {
 	/**
 	 * Timeout duration in milliseconds, if it is great than 0 and not Infinity
@@ -136,6 +145,7 @@ export type PromiseExecutor<T = void> = (
  * when the promise is not fulfilled. For example, instead of rejecting the promise, resolve with a
  * specific value.
  * @returns A new promise that will complete when the given promise resolves or the timeout expires.
+ * @internal
  */
 export async function timeoutAwait<T = void>(
 	promise: PromiseLike<T>,
@@ -152,6 +162,7 @@ export async function timeoutAwait<T = void>(
  * @param timeoutOptions - Options that can be used to override the timeout and / or define the behavior when
  * the promise is not fulfilled. For example, instead of rejecting the promise, resolve with a specific value.
  * @returns A new promise that will complete when the given executor resolves or the timeout expires.
+ * @internal
  */
 export async function timeoutPromise<T = void>(
 	executor: (