katanakit-js / useRace

Function: useRace()

function useRace<T>(
   promise, 
   timeoutMs, 
   errorMessage?
): Promise<T>;

Defined in: src/core/services/timing.service.ts:373

Races a promise against a timeout. Clears the timer when the promise wins so the timeout rejection cannot become an unhandled rejection.

Type Parameters

Type Parameter	Description
T	The promise's resolved type.

Parameters

Parameter	Type	Default value	Description
promise	Promise<T>	undefined	The promise to race.
timeoutMs	number	undefined	Timeout in milliseconds.
errorMessage	string	"Operation timed out"	Error message on timeout (defaults to "Operation timed out").

Returns

Promise<T>

The resolved value of the promise.

Throws

If the timeout fires first.

Example

try {
  const data = await useRace(fetch("/api"), 5000);
} catch (e) {
  console.error(e); // "Operation timed out"
}