solid-ctrl-flow 1.0.50 → 1.0.51

package/dist/index.d.ts

@@ -127,6 +127,15 @@ 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>;
 
+/**
+ * Defines a reactive property on an object
+ * @param obj The object on which to define the property
+ * @param k The key of the property that will be defined
+ * @param param2 The {@link Signal} to use as the data store of the property
+ * @returns The same thing passed as {@link obj}
+ */
+export declare function defineSignalProperty<const T, K extends keyof T>(obj: T, k: K, [get, set]: Signal<T[K]>): T;
+
 /**
  * Eventually wraps its content into a template if a certain condition is met.
  * If you set {@link Standard.recycled} to `true`, the content will be memoized in the beginning and will be recycled even if the wrapper changes.
@@ -278,7 +287,8 @@ export declare namespace Slot {
 }
 
 /**
- * Executes {@link splitProps} and memoizes the first of the two returned objects using {@link memoProps}
+ * Executes {@link splitProps} and memoizes the first of the two returned objects using {@link memoProps}.
+ * Unlike {@link splitProps}, this doesn't support multiple key-sets out of the box
  * @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

package/dist/index.mjs

@@ -67,6 +67,15 @@ function runWithContext(ctx2, value, f) {
 function untrackCall(f, ...args) {
   return untrack(() => f.apply(this, args));
 }
+function defineSignalProperty(obj, k, [get, set]) {
+  return Object.defineProperty(obj, k, {
+    get,
+    set,
+    enumerable: true,
+    writable: true,
+    configurable: true
+  });
+}
 function createReactiveResource(f) {
   var refetch;
   const memo = createMemo(f);
@@ -288,6 +297,7 @@ export {
   createExtractor,
   createReactiveResource,
   debug,
+  defineSignalProperty,
   memoProps,
   runWithContext,
   splitAndMemoProps,

package/dist/index.umd.js

@@ -69,6 +69,15 @@
   function untrackCall(f, ...args) {
     return solidJs.untrack(() => f.apply(this, args));
   }
+  function defineSignalProperty(obj, k, [get, set]) {
+    return Object.defineProperty(obj, k, {
+      get,
+      set,
+      enumerable: true,
+      writable: true,
+      configurable: true
+    });
+  }
   function createReactiveResource(f) {
     var refetch;
     const memo = solidJs.createMemo(f);
@@ -288,6 +297,7 @@
   exports2.createExtractor = createExtractor;
   exports2.createReactiveResource = createReactiveResource;
   exports2.debug = debug;
+  exports2.defineSignalProperty = defineSignalProperty;
   exports2.memoProps = memoProps;
   exports2.runWithContext = runWithContext;
   exports2.splitAndMemoProps = splitAndMemoProps;

package/package.json

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

package/readMe.md

@@ -43,7 +43,7 @@ If you are NOT wrapping the content with a context provider you can set the `rec
 ```tsx
 return <>
   <Enfold recycled when={value} template={c => <ctx.Provider value={2} children={c()} />}>
-    {/* This won't work */}
+    {/* This won't be 2 */}
     {useContext(ctx)}
   </Enfold>
 </>
@@ -215,6 +215,9 @@ return <>
 ### `untrackCall()`
 Calls a function untracking what happens inside of it but not what gets passed as its argument
 
+### `defineSignalProperty()`
+Defines a reactive property on an object
+
 ### `createReactiveResource()`
 Like `createResource()` but the provided function will be reactive