Usage

Reveal a profile after its resource settles

This type is used by resource

tsx
import { Catch, Loading, Spinner, Text, resource } from 'kuito';

function Profile() {
  const profile = resource(async ({ signal }) => {
    const response = await fetch('https://example.com/api/profile', { signal });
    if (!response.ok) throw new Error(`HTTP ${response.status}`);
    return (await response.json()) as { name: string };
  });
  return <Text>{profile.data.value?.name ?? ''}</Text>;
}

export function Account() {
  return (
    <Catch fallback={<Text>Profile unavailable</Text>}>
      <Loading fallback={<Spinner />}>
        <Profile />
      </Loading>
    </Catch>
  );
}

Type declaration

ts
export interface Resource<T> extends Task<[], T> {
  refresh(): Promise<T>;
}

Members 6

NameTypeRequiredDescription
refresh() => Promise<T>Yes—
runningreadonlyReadonlySignal<boolean>Yes—
datareadonlyReadonlySignal<T>Yes—
errorreadonlyReadonlySignal<unknown>Yes—
run() => Promise<T>Yes—
cancel(reason?: unknown) => voidYes—
refresh — method signatures

Signatures

ts
(): Promise<T>

Parameters

No parameters.

Returns

Promise<T>

run — method signatures

Signatures

ts
(): Promise<T>

Parameters

NameTypeRequiredDescription
...args[]Yes—

Returns

Promise<T>

cancel — method signatures

Signatures

ts
(reason?: unknown): void

Parameters

NameTypeRequiredDescription
reasonunknownNo—

Returns

void

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.