preact-sigma 2.1.0 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +6 -4
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -47,7 +47,11 @@ type DefaultStateValue<TValue> = TValue | DefaultStateInitializer<TValue>;
|
|
|
47
47
|
type Disposable = {
|
|
48
48
|
[Symbol.dispose](): void;
|
|
49
49
|
};
|
|
50
|
+
interface SigmaRefBrand {
|
|
51
|
+
[sigmaRefBrand]?: true;
|
|
52
|
+
}
|
|
50
53
|
/** A type brand added by `ref(...)`. */
|
|
54
|
+
type SigmaRef<T = unknown> = T & SigmaRefBrand;
|
|
51
55
|
/** The event map shape used by sigma types. */
|
|
52
56
|
type AnyEvents = Record<string, object | void>;
|
|
53
57
|
/** The top-level state object shape used by sigma types. */
|
|
@@ -150,9 +154,7 @@ declare function isSigmaState(value: unknown): value is AnySigmaState;
|
|
|
150
154
|
* Returns `value` unchanged and marks its type so sigma's Draft and Immutable
|
|
151
155
|
* helpers keep it by reference instead of recursively immerizing it.
|
|
152
156
|
*/
|
|
153
|
-
declare function ref<T extends object>(value: T): T
|
|
154
|
-
[sigmaRefBrand]?: true;
|
|
155
|
-
};
|
|
157
|
+
declare function ref<T extends object>(value: T): SigmaRef<T>;
|
|
156
158
|
/** Creates a standalone tracked query function with the same signature as `fn`. */
|
|
157
159
|
declare function query<TArgs extends any[], TResult>(fn: (this: void, ...args: TArgs) => TResult): typeof fn;
|
|
158
160
|
/**
|
|
@@ -236,4 +238,4 @@ declare function useSigma<T extends AnySigmaState>(create: () => T, setupArgs?:
|
|
|
236
238
|
/** Attaches an event listener in a component and cleans it up when dependencies change. */
|
|
237
239
|
declare function useListener<TTarget extends EventTarget | AnySigmaState, TEvent extends InferEventType<TTarget>>(target: TTarget | null, name: TEvent, listener: InferListener<TTarget, TEvent>): void;
|
|
238
240
|
//#endregion
|
|
239
|
-
export { type AnyDefaultState, type AnyEvents, type AnyResource, type AnySigmaState, type AnySigmaStateWithEvents, type AnyState, InferEventType, InferListener, type InferSetupArgs, type SigmaObserveChange, type SigmaObserveOptions, type SigmaState, SigmaType, action, batch, computed, effect, freeze, immerable, isSigmaState, listen, query, ref, replaceState, setAutoFreeze, snapshot, untracked, useListener, useSigma };
|
|
241
|
+
export { type AnyDefaultState, type AnyEvents, type AnyResource, type AnySigmaState, type AnySigmaStateWithEvents, type AnyState, InferEventType, InferListener, type InferSetupArgs, type SigmaObserveChange, type SigmaObserveOptions, type SigmaRef, type SigmaState, SigmaType, action, batch, computed, effect, freeze, immerable, isSigmaState, listen, query, ref, replaceState, setAutoFreeze, snapshot, untracked, useListener, useSigma };
|