solid-ctrl-flow 1.0.37 → 1.0.38

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { Accessor } from 'solid-js';
 import { Context } from 'solid-js';
 import { EffectFunction } from 'solid-js';
 import { JSX } from 'solid-js';
+import { MemoOptions } from 'solid-js';
 import { Ref } from 'solid-js';
 import { Resource } from 'solid-js';
 import { Setter } from 'solid-js';
@@ -132,6 +133,9 @@ export declare function createReactiveResource<R>(f: EffectFunction<R | undefine
 /** Built-in {@link ReactiveContext} which allows you to display different things in debug mode */
 export declare const debug: ReactiveContext<boolean>;
 
+/** Handy type alias */
+declare type Equals = MemoOptions<unknown>["equals"];
+
 /** Informations about a {@link Source} component */
 declare type Info = {
     /** Order of the current source if there are many */
@@ -140,12 +144,16 @@ declare type Info = {
 };
 
 /**
- * Memoizes some of the properties of {@link obj}
- * If {@link keys} is not provided, memoizes everything that get returned by {@link Object.keys} when provided with {@link obj}
+ * Memoizes some of the properties of {@link obj}.
+ * If {@link keys} is not provided, memoizes everything that get returned by {@link Object.keys} when provided with {@link obj}.
+ * The {@link equals} parameter defaults to `false` to allow the specific reactive value to have control over when its dependant effects are triggered
  * @param obj Object to partially memoize
  * @param keys The keys of the properties to memoize
+ * @param equals The comparator function to use on the newly created memos
  */
-export declare function memoProps<T, K extends readonly (keyof T)[] = (keyof T)[]>(obj: T, keys?: K): Pick<T, K[number]>;
+export declare function memoProps<T>(obj: T, keys?: undefined, equals?: Equals): T;
+
+export declare function memoProps<T, K extends readonly (keyof T)[]>(obj: T, keys: K, equals?: Equals): Pick<T, K[number]>;
 
 /**
  * Like a {@link For}, but instead of putting an element after another it nests them.
@@ -229,11 +237,12 @@ export declare function runWithContext<T, V extends T, R>(ctx: Context<T>, value
 export declare function runWithContext<T, R>(ctx: Context<T>, value: T | undefined, f: (x: T) => R): R;
 
 /**
- * Executes {@link splitProps} and memoizes the first of the two returned objects
+ * Executes {@link splitProps} and memoizes the first of the two returned objects using {@link memoProps}
  * @param obj Object to split and partially memoize
  * @param keys The keys of the properties to memoize and to include in the first of the two objects
+ * @param equals The comparator function to use on the newly created memos
  */
-export declare function splitAndMemoProps<T extends object, K extends readonly (keyof T)[]>(obj: T, keys: K): [Pick<T, Extract<K, readonly (keyof T)[]>[number]>, Omit<T, K[number]>];
+export declare function splitAndMemoProps<T extends Record<any, any>, K extends readonly (keyof T)[]>(obj: T, keys: K, equals?: Equals): [Pick<T, Extract<K, readonly (keyof T)[]>[number]>, Omit<T, K[number]>];
 
 /**
  * Creates a full-fledged solid {@link Setter} from a normal one

package/dist/index.mjs

@@ -191,18 +191,20 @@ function refCall(ref, value) {
   ref(value);
   return value;
 }
-function memoProps(obj, keys = Object.keys(obj)) {
+function memoProps(obj, keys = Object.keys(obj), equals = false) {
   const out = {};
   for (const elm of keys)
     Object.defineProperty(out, elm, {
       enumerable: true,
-      get: createMemo(() => obj[elm])
+      get: createMemo(() => obj[elm], void 0, {
+        equals
+      })
     });
   return out;
 }
-function splitAndMemoProps(obj, keys) {
+function splitAndMemoProps(obj, keys, equals) {
   const out = splitProps(obj, keys);
-  out[0] = memoProps(out[0], keys);
+  out[0] = memoProps(out[0], keys, equals);
   return out;
 }
 function runWithContext(ctx2, value, f) {

package/dist/index.umd.js

@@ -193,18 +193,20 @@
     ref(value);
     return value;
   }
-  function memoProps(obj, keys = Object.keys(obj)) {
+  function memoProps(obj, keys = Object.keys(obj), equals = false) {
     const out = {};
     for (const elm of keys)
       Object.defineProperty(out, elm, {
         enumerable: true,
-        get: solidJs.createMemo(() => obj[elm])
+        get: solidJs.createMemo(() => obj[elm], void 0, {
+          equals
+        })
       });
     return out;
   }
-  function splitAndMemoProps(obj, keys) {
+  function splitAndMemoProps(obj, keys, equals) {
     const out = solidJs.splitProps(obj, keys);
-    out[0] = memoProps(out[0], keys);
+    out[0] = memoProps(out[0], keys, equals);
     return out;
   }
   function runWithContext(ctx2, value, f) {

package/package.json

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