solid-ctrl-flow 1.0.26 → 1.0.27

package/dist/index.d.ts

@@ -7,7 +7,11 @@ import { Setter } from 'solid-js';
 import { Signal } from 'solid-js';
 
 /**
- * Creates a one-way binding between two {@link Signal}s
+ * Creates a one-way binding between two {@link Signal}s.
+ * The function uses {@link createRenderEffect}, which means that:
+ * - As soon as the function is done executing the two {@link Signal}s will have the same value
+ * - If {@link source} changes, {@link dest} wont be instantly updated
+ * - If the current owner gets disposed before {@link dest} is updated, it never will
  * @param source The source of the binding
  * @param dest The destination of the binding
  * @param to Conversion function from {@link S} to {@link D}
@@ -18,7 +22,7 @@ export declare function bind<S>(source: Signal<S>, dest: Signal<S>): () => void;
 export declare function bind<S, D>(source: Signal<S>, dest: Signal<D>, to: Convert<S, D>): () => void;
 
 /**
- * Creates a two-way binding between two {@link Signal}s
+ * Creates a two-way binding between two {@link Signal}s calling {@link bind} two times
  * @param source The source of the binding
  * @param dest The destination of the binding
  * @param to Conversion function from {@link S} to {@link D}
@@ -68,7 +72,7 @@ export declare function Case(props: {
  * Returns a {@link Signal} that applies the `??=` operator to the input one.
  * If the getter of {@link param0} is like "x", then the result one is like "(x ??= {@link f}())"
  * @param param0 The {@link Signal} to which to coalesce the getter
- * @param f A function that creates a new {@link T}
+ * @param f An {@link Accessor} to the value to use when there's a nullish value
  */
 export declare function coalesceSignal<T>([get, set]: Signal<T | undefined>, f: Accessor<T>): Signal<T>;
 
@@ -205,7 +209,7 @@ export declare function toSignal<T, K extends keyof T>(obj: Accessor<T>, k: Acce
  * @param args Arguments for calling {@link f}
  * @returns The same thing {@link f} returned
  */
-export declare function untrackCall<F extends (...args: any[]) => any>(this: ThisParameterType<F>, f: F, ...args: Parameters<F>): any;
+export declare function untrackCall<F extends (...args: any[]) => any>(this: ThisParameterType<F>, f: F, ...args: Parameters<F>): ReturnType<F>;
 
 /**
  * Calls {@link f} maintaining its reactivity

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "solid-ctrl-flow",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "description": "Control flow components for solid-js",
   "author": "AFatNiBBa",
   "license": "ISC",