@shtse8/fluxus v1.0.0

---

@shtse8/fluxus / src / asyncProvider

Function: asyncProvider()

asyncProvider<T>(create, options?): AsyncProviderInstance<T>

Defined in: src/providers/asyncProvider.ts:96

Creates an AsyncProvider.

An AsyncProvider manages the state of an asynchronous operation, typically represented by a Promise. It exposes the state as an AsyncValue<T>, transitioning through loading, data, and error states.

Type Parameters

T

T

The type of data the asynchronous operation produces.

Parameters

create

(read) => Promise<T>

A function that takes a ScopeReader (which includes an optional signal property for cancellation) and returns a Promise resolving to the data.

options?

AsyncProviderOptions

Returns

AsyncProviderInstance<T>

An AsyncProviderInstance.

Example

const userProvider = asyncProvider(async (reader) => {
  const userId = reader.read(userIdProvider);
  // Pass the signal from the reader to fetch for cancellation
  const response = await fetch(`/api/users/${userId}`, { signal: reader.signal });
  if (!response.ok) {
    // Handle potential AbortError if the request was cancelled
    if (response.status === 0 && reader.signal?.aborted) {
      console.log('User fetch aborted.');
      // You might want to throw a specific error or return a default state
      throw new Error('Fetch aborted');
    }
    throw new Error('Failed to fetch user');
  }
  return await response.json() as User;
});