tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / withTimeout

Function: withTimeout()

function withTimeout<T, E>(
  resultPromise,
  timeoutMs,
  timeoutMessage?
): Promise<TryResult<T, TryError<string> | E>>;

Defined in: async.ts:428

Add a timeout to any Promise<TryResult>

Type Parameters

T

T

E

E extends TryError<string>

Parameters

resultPromise

Promise<TryResult<T, E>>

Promise to add timeout to

timeoutMs

number

Timeout in milliseconds

timeoutMessage?

string

Optional custom timeout message

Returns

Promise<TryResult<T, TryError<string> | E>>

Promise that rejects with timeout error if not resolved in time

Example

const result = await withTimeout(
  tryAsync(() => fetch("/api/slow")),
  5000,
  "API request timed out"
);