@solid-primitives/utils 0.4.0 → 0.5.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.cjs CHANGED
@@ -33,6 +33,8 @@ __export(src_exports, {
33
33
  createCallbackStack: () => createCallbackStack,
34
34
  createMicrotask: () => createMicrotask,
35
35
  createProxy: () => createProxy,
36
+ createTrigger: () => createTrigger,
37
+ createTriggerCache: () => createTriggerCache,
36
38
  definite: () => definite,
37
39
  destore: () => destore,
38
40
  entries: () => entries,
@@ -94,7 +96,7 @@ var includes = (arr, ...items) => {
94
96
  }
95
97
  return false;
96
98
  };
97
- var access = (v) => isFunction(v) ? v() : v;
99
+ var access = (v) => isFunction(v) && !v.length ? v() : v;
98
100
  var accessAsArray = (value) => asArray(access(value));
99
101
  var asArray = (value) => Array.isArray(value) ? value : [value];
100
102
  var accessArray = (list) => list.map((v) => access(v));
@@ -113,7 +115,7 @@ var forEachEntry = (object, iterator) => {
113
115
  Object.entries(obj).forEach(([key, item], index, pairs) => iterator(key, item, index, pairs, obj));
114
116
  };
115
117
  var entries = (object) => Object.entries(access(object));
116
- var keys = (object) => Object.keys(access(object));
118
+ var keys = Object.keys;
117
119
  var promiseTimeout = (ms, throwOnTimeout = false, reason = "Timeout") => new Promise((resolve, reject) => throwOnTimeout ? setTimeout(() => reject(reason), ms) : setTimeout(resolve, ms));
118
120
  function raceTimeout(input, ms, throwOnTimeout = false, reason = "Timeout") {
119
121
  const promises = asArray(input);
@@ -162,6 +164,27 @@ function createProxy(traps) {
162
164
  }
163
165
  });
164
166
  }
167
+ function createTrigger(options) {
168
+ return (0, import_solid_js.createSignal)(void 0, { equals: false, name: options == null ? void 0 : options.name });
169
+ }
170
+ function createTriggerCache(options) {
171
+ const cache = /* @__PURE__ */ new Map();
172
+ return {
173
+ dirty: (key) => {
174
+ var _a;
175
+ return (_a = cache.get(key)) == null ? void 0 : _a[1]();
176
+ },
177
+ dirtyAll: () => cache.forEach((s) => s[1]()),
178
+ track(key) {
179
+ let trigger = cache.get(key);
180
+ if (!trigger) {
181
+ trigger = createTrigger(options);
182
+ cache.set(key, trigger);
183
+ }
184
+ trigger[0]();
185
+ }
186
+ };
187
+ }
165
188
  module.exports = __toCommonJS(src_exports);
166
189
  // Annotate the CommonJS export names for ESM import in node:
167
190
  0 && (module.exports = {
@@ -174,6 +197,8 @@ module.exports = __toCommonJS(src_exports);
174
197
  createCallbackStack,
175
198
  createMicrotask,
176
199
  createProxy,
200
+ createTrigger,
201
+ createTriggerCache,
177
202
  definite,
178
203
  destore,
179
204
  entries,
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { Accessor, onCleanup } from 'solid-js';
2
- import { OnOptions, EffectFunction, NoInfer } from 'solid-js/types/reactive/signal';
2
+ import { OnOptions, EffectFunction, NoInfer, BaseOptions } from 'solid-js/types/reactive/signal';
3
3
  import { Store } from 'solid-js/store';
4
4
  export { isServer } from 'solid-js/web';
5
5
 
@@ -38,7 +38,7 @@ declare type MaybeAccessor<T> = T | Accessor<T>;
38
38
  * // => string | void
39
39
  * ```
40
40
  */
41
- declare type MaybeAccessorValue<T extends MaybeAccessor<any>> = T extends Fn ? ReturnType<T> : T;
41
+ declare type MaybeAccessorValue<T extends MaybeAccessor<any>> = T extends () => any ? ReturnType<T> : T;
42
42
  declare type OnAccessEffectFunction<S, Prev, Next extends Prev = Prev> = (input: AccessReturnTypes<S>, prevInput: AccessReturnTypes<S>, v: Prev) => Next;
43
43
  declare type AccessReturnTypes<S> = S extends MaybeAccessor<any>[] ? {
44
44
  [I in keyof S]: AccessReturnTypes<S[I]>;
@@ -71,6 +71,12 @@ declare type Fallback<T, F = NonNullable<T>> = NonNullable<T> | F;
71
71
  declare type Destore<T extends Object> = {
72
72
  [K in keyof T]: T[K] extends Function ? T[K] : Accessor<T[K]>;
73
73
  };
74
+ declare type TriggerCache<T> = {
75
+ track: Get<T>;
76
+ dirty: Get<T>;
77
+ dirtyAll: Fn;
78
+ };
79
+ declare type Trigger = [track: Fn, dirty: Fn];
74
80
  declare type Position = {
75
81
  x: number;
76
82
  y: number;
@@ -185,9 +191,9 @@ declare const forEachEntry: <A extends MaybeAccessor<object>, O = MaybeAccessorV
185
191
  */
186
192
  declare const entries: <A extends MaybeAccessor<object>, O = MaybeAccessorValue<A>>(object: A) => [keyof O, Values<O>][];
187
193
  /**
188
- * Get `Object.keys()` of an MaybeAccessor<Object>
194
+ * Get keys of an object
189
195
  */
190
- declare const keys: <A extends MaybeAccessor<object>>(object: A) => (keyof MaybeAccessorValue<A>)[];
196
+ declare const keys: <T extends object>(object: T) => (keyof T)[];
191
197
  /**
192
198
  * Creates a promise that resolves *(or rejects)* after given time.
193
199
  *
@@ -266,5 +272,34 @@ declare function createProxy<T extends Record<string | symbol, any>>(traps: {
266
272
  get: <K extends keyof T>(key: K) => T[K];
267
273
  set?: undefined;
268
274
  }): Readonly<T>;
275
+ /**
276
+ * Set listeners in reactive computations and then trigger them when you want.
277
+ * @returns `[track function, dirty function]`
278
+ * @example
279
+ * const [track, dirty] = createTrigger()
280
+ * createEffect(() => {
281
+ * track()
282
+ * ...
283
+ * })
284
+ * // later
285
+ * dirty()
286
+ */
287
+ declare function createTrigger(options?: BaseOptions): Trigger;
288
+ /**
289
+ * Set listeners in reactive computations and then trigger them when you want. Cache trackers by a `key`.
290
+ * @returns `{ track, dirty, dirtyAll }` functions
291
+ * `track` and `dirty` are called with a `key` so that each tracker will trigger an update only when his individual `key` would get marked as dirty.
292
+ * @example
293
+ * const { track, dirty } = createTriggerCache()
294
+ * createEffect(() => {
295
+ * track(1)
296
+ * ...
297
+ * })
298
+ * // later
299
+ * dirty(1)
300
+ * // this won't cause an update:
301
+ * dirty(2)
302
+ */
303
+ declare function createTriggerCache<T>(options?: BaseOptions): TriggerCache<T>;
269
304
 
270
- export { AccessReturnTypes, AnyClass, AnyFunction, AnyObject, Clear, DeepPartialAny, Destore, Directive, ExtractIfPossible, Fallback, Falsy, FalsyValue, Fn, Get, ItemsOf, ItemsOfMany, Keys, LiteralKey, Many, MaybeAccessor, MaybeAccessorValue, Modify, ModifyDeep, Noop, OnAccessEffectFunction, Position, PrimitiveValue, Truthy, UnionToIntersection, Values, access, accessArray, accessAsArray, asAccessor, asArray, compare, createCallbackStack, createMicrotask, createProxy, definite, destore, entries, forEach, forEachEntry, includes, isArray, isBoolean, isClient, isDefined, isDev, isFunction, isNumber, isObject, isProd, isString, keys, noop, ofClass, onAccess, onRootCleanup, promiseTimeout, raceTimeout, tuple, warn, withAccess, withFallback, withFallbackFn };
305
+ export { AccessReturnTypes, AnyClass, AnyFunction, AnyObject, Clear, DeepPartialAny, Destore, Directive, ExtractIfPossible, Fallback, Falsy, FalsyValue, Fn, Get, ItemsOf, ItemsOfMany, Keys, LiteralKey, Many, MaybeAccessor, MaybeAccessorValue, Modify, ModifyDeep, Noop, OnAccessEffectFunction, Position, PrimitiveValue, Trigger, TriggerCache, Truthy, UnionToIntersection, Values, access, accessArray, accessAsArray, asAccessor, asArray, compare, createCallbackStack, createMicrotask, createProxy, createTrigger, createTriggerCache, definite, destore, entries, forEach, forEachEntry, includes, isArray, isBoolean, isClient, isDefined, isDev, isFunction, isNumber, isObject, isProd, isString, keys, noop, ofClass, onAccess, onRootCleanup, promiseTimeout, raceTimeout, tuple, warn, withAccess, withFallback, withFallbackFn };
package/dist/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  // src/index.ts
2
- import { getOwner, onCleanup, on, DEV } from "solid-js";
2
+ import { getOwner, onCleanup, on, createSignal, DEV } from "solid-js";
3
3
  import { isServer } from "solid-js/web";
4
4
  var noop = () => void 0;
5
5
  var isClient = !isServer;
@@ -30,7 +30,7 @@ var includes = (arr, ...items) => {
30
30
  }
31
31
  return false;
32
32
  };
33
- var access = (v) => isFunction(v) ? v() : v;
33
+ var access = (v) => isFunction(v) && !v.length ? v() : v;
34
34
  var accessAsArray = (value) => asArray(access(value));
35
35
  var asArray = (value) => Array.isArray(value) ? value : [value];
36
36
  var accessArray = (list) => list.map((v) => access(v));
@@ -49,7 +49,7 @@ var forEachEntry = (object, iterator) => {
49
49
  Object.entries(obj).forEach(([key, item], index, pairs) => iterator(key, item, index, pairs, obj));
50
50
  };
51
51
  var entries = (object) => Object.entries(access(object));
52
- var keys = (object) => Object.keys(access(object));
52
+ var keys = Object.keys;
53
53
  var promiseTimeout = (ms, throwOnTimeout = false, reason = "Timeout") => new Promise((resolve, reject) => throwOnTimeout ? setTimeout(() => reject(reason), ms) : setTimeout(resolve, ms));
54
54
  function raceTimeout(input, ms, throwOnTimeout = false, reason = "Timeout") {
55
55
  const promises = asArray(input);
@@ -98,6 +98,27 @@ function createProxy(traps) {
98
98
  }
99
99
  });
100
100
  }
101
+ function createTrigger(options) {
102
+ return createSignal(void 0, { equals: false, name: options == null ? void 0 : options.name });
103
+ }
104
+ function createTriggerCache(options) {
105
+ const cache = /* @__PURE__ */ new Map();
106
+ return {
107
+ dirty: (key) => {
108
+ var _a;
109
+ return (_a = cache.get(key)) == null ? void 0 : _a[1]();
110
+ },
111
+ dirtyAll: () => cache.forEach((s) => s[1]()),
112
+ track(key) {
113
+ let trigger = cache.get(key);
114
+ if (!trigger) {
115
+ trigger = createTrigger(options);
116
+ cache.set(key, trigger);
117
+ }
118
+ trigger[0]();
119
+ }
120
+ };
121
+ }
101
122
  export {
102
123
  access,
103
124
  accessArray,
@@ -108,6 +129,8 @@ export {
108
129
  createCallbackStack,
109
130
  createMicrotask,
110
131
  createProxy,
132
+ createTrigger,
133
+ createTriggerCache,
111
134
  definite,
112
135
  destore,
113
136
  entries,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@solid-primitives/utils",
3
- "version": "0.4.0",
3
+ "version": "0.5.2",
4
4
  "description": "A bunch of reactive utility types and functions, for building primitives with Solid.js",
5
5
  "author": "Damian Tarnawski @thetarnav <gthetarnav@gmail.com>",
6
6
  "license": "MIT",
@@ -44,4 +44,4 @@
44
44
  "peerDependencies": {
45
45
  "solid-js": "^1.3.1"
46
46
  }
47
- }
47
+ }