@solidjs/signals 0.4.11 → 0.6.0

package/dist/types/core/scheduler.d.ts

@@ -78,7 +78,7 @@ export declare class Transition implements IQueue {
  *
  * @description https://docs.solidjs.com/reference/advanced-reactivity/transition
  */
-export declare function transition(fn: (resume: (fn: () => any | Promise<any>) => void) => any | Promise<any>): void;
+export declare function transition(fn: (resume: (fn: () => any | Promise<any>) => void) => any | Promise<any> | Iterable<any>): void;
 export declare function cloneGraph(node: Computation): Computation;
 export declare function getOGSource<T extends Computation>(input: T): T;
 export declare function getTransitionSource<T extends Computation>(input: T): T;

package/dist/types/signals.d.ts

@@ -1,5 +1,6 @@
 import type { SignalOptions } from "./core/index.js";
 import { Owner } from "./core/index.js";
+import { type Store, type StoreSetter } from "./store/index.js";
 export type Accessor<T> = () => T;
 export type Setter<in out T> = {
     <U extends T>(...args: undefined extends T ? [] : [value: Exclude<U, Function> | ((prev: T) => U)]): undefined extends T ? undefined : U;
@@ -146,28 +147,34 @@ export declare function runWithOwner<T>(owner: Owner | null, run: () => T): T;
  * @param fn a reactive expression to resolve
  */
 export declare function resolve<T>(fn: () => T): Promise<T>;
-/**
- * Runs the given function and returns a tuple with the result or an error.
- * If the function throws an error, it will be caught and returned as the first element of the tuple.
- * If the function returns a promise, it will resolve to a tuple with the result or an error.
+/** Allows the user to mark a state change as non-urgent.
  *
- * @param fn The function to run.
- * @returns A tuple with either [undefined, result] or [error].
+ * @see {@link https://docs.solidjs.com/reference/advanced-reactivity/transition}
  *
- * @description https://docs.solidjs.com/reference/reactive-utilities/try-catch
+ * @returns A tuple containing an accessor for the pending state and a function to start a transition.
  */
-export type TryCatchResult<T, E> = [undefined, T] | [E];
-export declare function tryCatch<T, E = Error>(fn: () => Promise<T>): Promise<TryCatchResult<T, E>>;
-export declare function tryCatch<T, E = Error>(fn: () => T): TryCatchResult<T, E>;
+export declare function useTransition(): [
+    get: Accessor<boolean>,
+    start: (fn: (resume: (fn: () => any | Promise<any>) => void) => any | Promise<any> | Iterable<any>) => void
+];
 /**
- * Creates an optimistic signal that can be used to optimistically update a value
+ * Creates an optimistic store that can be used to optimistically update a value
  * and then revert it back to the previous value at end of transition.
- *
+ * ```typescript
+ * export function createOptimistic<T>(
+ *   fn: (store: T) => void,
+ *   initial: T,
+ *   options?: { key?: string | ((item: NonNullable<any>) => any); all?: boolean }
+ * ): [get: Store<T>, set: StoreSetter<T>];
+ * ```
+ * @param fn a function that receives the current store and can be used to mutate it directly inside a transition
  * @param initial The initial value of the signal.
- * @param compute An optional function to compute the next value based on the previous value and change.
  * @param options Optional signal options.
  *
  * @returns A tuple containing an accessor for the current value and a setter function to apply changes.
  */
-export declare function createOptimistic<T>(initial: Exclude<T, Function>, compute?: never): [Accessor<T>, (value: T | ((v?: T) => T)) => void];
-export declare function createOptimistic<T extends object, U>(initial: T | Accessor<T>, compute: (prev: T, change: U) => void, key: string | ((item: any) => any)): [Accessor<T>, (value: U | ((v?: U) => U)) => void];
+export declare function createOptimistic<T extends object = {}>(initial: T | Store<T>): [get: Store<T>, set: StoreSetter<T>];
+export declare function createOptimistic<T extends object = {}>(fn: (store: T) => void, initial: T | Store<T>, options?: {
+    key?: string | ((item: NonNullable<any>) => any);
+    all?: boolean;
+}): [get: Store<T>, set: StoreSetter<T>];

package/dist/types/store/projection.d.ts

@@ -1,7 +1,7 @@
-import { type Store } from "./store.js";
+import { type Store, type StoreOptions } from "./store.js";
 /**
  * Creates a mutable derived value
  *
  * @see {@link https://github.com/solidjs/x-reactivity#createprojection}
  */
-export declare function createProjection<T extends Object>(fn: (draft: T) => void, initialValue?: T): Store<T>;
+export declare function createProjection<T extends Object>(fn: (draft: T) => void | T, initialValue?: T, options?: StoreOptions): Store<T>;

package/dist/types/store/store.d.ts

@@ -1,6 +1,10 @@
 import { Computation } from "../core/index.js";
 export type Store<T> = Readonly<T>;
-export type StoreSetter<T> = (fn: (state: T) => void) => void;
+export type StoreSetter<T> = (fn: (state: T) => T | void) => void;
+export type StoreOptions = {
+    key?: string | ((item: NonNullable<any>) => any);
+    all?: boolean;
+};
 type DataNode = Computation<any>;
 type DataNodes = Record<PropertyKey, DataNode>;
 export declare const $TRACK: unique symbol, $DEEP: unique symbol, $TARGET: unique symbol, $PROXY: unique symbol, $DELETED: unique symbol;
@@ -26,8 +30,8 @@ export declare function isWrappable<T>(obj: T | NotWrappable): obj is T;
 export declare function getKeys(source: Record<PropertyKey, any>, override: Record<PropertyKey, any> | undefined, enumerable?: boolean): PropertyKey[];
 export declare function getPropertyDescriptor(source: Record<PropertyKey, any>, override: Record<PropertyKey, any> | undefined, property: PropertyKey): PropertyDescriptor | undefined;
 export declare const storeTraps: ProxyHandler<StoreNode>;
-export declare function storeSetter<T extends object>(store: Store<T>, fn: (draft: T) => void): void;
+export declare function storeSetter<T extends object>(store: Store<T>, fn: (draft: T) => T | void): void;
 export declare function createStore<T extends object = {}>(store: T | Store<T>): [get: Store<T>, set: StoreSetter<T>];
-export declare function createStore<T extends object = {}>(fn: (store: T) => void, store: T | Store<T>): [get: Store<T>, set: StoreSetter<T>];
-export declare function deep<T extends object>(store: Store<T>): Store<any>;
+export declare function createStore<T extends object = {}>(fn: (store: T) => void, store: T | Store<T>, options?: StoreOptions): [get: Store<T>, set: StoreSetter<T>];
+export declare function deep<T extends object>(store: Store<T>): Store<T>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidjs/signals",
-  "version": "0.4.11",
+  "version": "0.6.0",
   "description": "",
   "author": "Ryan Carniato",
   "license": "MIT",