@solid-primitives/until

Promised one-time watch for changes. Await a reactive condition.

Installation

1npm install @solid-primitives/until
2# or
3yarn add @solid-primitives/until

How to use it

It takes a signal or a reactive condition — which will resolve the promise if truthy — as an argument.

Returns a promise that resolves a truthy value of a condition. Or rejects when it's root get's disposed.

Import

1import { until } from "@solid-primitives/until";

With a custom reactive condition:

no need for createMemo, it's memoized internally

1const [count, setCount] = createSignal(0);
2
3await until(() => count() > 5);

With createResource

Wait for async data to be ready. Or just any signal as a source, that can be truthy/falsy.

1const [data] = createResource(fetcher);
2
3const result = await until(data);

Actually, since it return a promise, it also can be used as a source for createResource.

1const [state, setState] = createSignal(null);
2
3const [data] = createResource(() => until(state));
4
5const result = await until(data);

With raceTimeout

To limit the maximum time it has for resolving

1import { raceTimeout } from "@solid-primitives/utils";
2try {
3  const result = await raceTimeout(until(condition), 2000, true, "until was too slow");
4  // if until is quicker:
5  result; // => truthy condition value
6} catch (err) {
7  // if timeouts:
8  console.log(err); // => "until was too slow"
9}

Manually stopping computation

If you don't want to use raceTimeout, there are other ways to stop the reactive computation of until if needed.

First, it will stop itself "onCleanup".

1// the same goes for components as they are roots too
2createRoot(dispose => {
3
4  // disposing root causes the promise to reject,
5  // so you need to catch that outcome to prevent errors
6  until(condition)
7    .then(res => {...})
8    .catch(() => {})
9
10  dispose()
11})

Second, using the .dispose() method.

1// until returns a promise with a dispose method in it
2const promise = until(condition);
3
4// you need to catch the rejection here too
5promise.then().catch();
6
7promise.dispose();

Demo

until + createResource demo: https://codesandbox.io/s/until-resource-demo-sfs7c?file=/src/index.tsx

until as createResource fetcher: https://codesandbox.io/s/until-as-resource-fetcher-6sl0e?file=/src/index.tsx

Changelog

Expand Changelog

0.0.100

Initial release as a Stage-1 primitive.

0.0.150

Upgraded to Solid 1.3

Inspiration

Original idea for this primitive comes from a VueUse's function of the same name.