aberdeen 1.7.0 → 1.7.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/README.md +17 -11
- package/dist/aberdeen.js +52 -31
- package/dist/aberdeen.js.map +3 -3
- package/dist-min/aberdeen.js +8 -9
- package/dist-min/aberdeen.js.map +3 -3
- package/package.json +1 -1
- package/skill/aberdeen.md +49 -49
- package/skill/dispatcher.md +6 -6
- package/skill/prediction.md +3 -3
- package/skill/route.md +17 -17
- package/skill/transitions.md +3 -3
- package/src/aberdeen.ts +51 -32
package/package.json
CHANGED
package/skill/aberdeen.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**Aberdeen v1.7.
|
|
1
|
+
[**Aberdeen v1.7.2**](README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
### PromiseProxy
|
|
12
12
|
|
|
13
|
-
Defined in: [aberdeen.ts:1360](https://github.com/vanviegen/aberdeen/blob/
|
|
13
|
+
Defined in: [aberdeen.ts:1360](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1360)
|
|
14
14
|
|
|
15
15
|
When `proxy` is called with a Promise, the returned object has this shape.
|
|
16
16
|
|
|
@@ -26,7 +26,7 @@ When `proxy` is called with a Promise, the returned object has this shape.
|
|
|
26
26
|
|
|
27
27
|
> **busy**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [aberdeen.ts:1364](https://github.com/vanviegen/aberdeen/blob/
|
|
29
|
+
Defined in: [aberdeen.ts:1364](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1364)
|
|
30
30
|
|
|
31
31
|
True if the promise is still pending, false if it has resolved or rejected.
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ True if the promise is still pending, false if it has resolved or rejected.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **error**: `any`
|
|
36
36
|
|
|
37
|
-
Defined in: [aberdeen.ts:1372](https://github.com/vanviegen/aberdeen/blob/
|
|
37
|
+
Defined in: [aberdeen.ts:1372](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1372)
|
|
38
38
|
|
|
39
39
|
If the promise has rejected, this contains the rejection error.
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ If the promise has rejected, this contains the rejection error.
|
|
|
42
42
|
|
|
43
43
|
> `optional` **value**: `T`
|
|
44
44
|
|
|
45
|
-
Defined in: [aberdeen.ts:1368](https://github.com/vanviegen/aberdeen/blob/
|
|
45
|
+
Defined in: [aberdeen.ts:1368](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1368)
|
|
46
46
|
|
|
47
47
|
If the promise has resolved, this contains the resolved value.
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ If the promise has resolved, this contains the resolved value.
|
|
|
52
52
|
|
|
53
53
|
> `const` **cssVars**: `Record`\<`string`, `string`\>
|
|
54
54
|
|
|
55
|
-
Defined in: [aberdeen.ts:1772](https://github.com/vanviegen/aberdeen/blob/
|
|
55
|
+
Defined in: [aberdeen.ts:1772](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1772)
|
|
56
56
|
|
|
57
57
|
A reactive object containing CSS variable definitions.
|
|
58
58
|
|
|
@@ -91,7 +91,7 @@ $('div mt:$3'); // Sets margin-top to var(--m3)
|
|
|
91
91
|
|
|
92
92
|
> `const` **NO\_COPY**: *typeof* [`NO_COPY`](#no_copy)
|
|
93
93
|
|
|
94
|
-
Defined in: [aberdeen.ts:1736](https://github.com/vanviegen/aberdeen/blob/
|
|
94
|
+
Defined in: [aberdeen.ts:1736](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1736)
|
|
95
95
|
|
|
96
96
|
A symbol that can be added to an object to prevent it from being cloned by [clone](#clone) or [copy](#copy).
|
|
97
97
|
This is useful for objects that should be shared by reference. That also mean that their contents won't
|
|
@@ -103,7 +103,7 @@ be observed for changes.
|
|
|
103
103
|
|
|
104
104
|
> **$**(...`args`): `undefined` \| `Element`
|
|
105
105
|
|
|
106
|
-
Defined in: [aberdeen.ts:
|
|
106
|
+
Defined in: [aberdeen.ts:2134](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2134)
|
|
107
107
|
|
|
108
108
|
The core function for building reactive user interfaces in Aberdeen. It creates and inserts new DOM elements
|
|
109
109
|
and sets attributes/properties/event listeners on DOM elements. It does so in a reactive way, meaning that
|
|
@@ -234,7 +234,7 @@ This is often used together with [ref](#ref), in order to use properties other t
|
|
|
234
234
|
|
|
235
235
|
> **clean**(`cleaner`): `void`
|
|
236
236
|
|
|
237
|
-
Defined in: [aberdeen.ts:
|
|
237
|
+
Defined in: [aberdeen.ts:2634](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2634)
|
|
238
238
|
|
|
239
239
|
Registers a cleanup function to be executed just before the current reactive scope
|
|
240
240
|
is destroyed or redraws.
|
|
@@ -289,7 +289,7 @@ setInterval(() => myArray[rnd()] = rnd(), 1000);
|
|
|
289
289
|
|
|
290
290
|
> **clone**\<`T`\>(`src`): `T`
|
|
291
291
|
|
|
292
|
-
Defined in: [aberdeen.ts:
|
|
292
|
+
Defined in: [aberdeen.ts:1871](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1871)
|
|
293
293
|
|
|
294
294
|
Clone an (optionally proxied) object or array.
|
|
295
295
|
|
|
@@ -323,7 +323,7 @@ A new unproxied array or object (of the same type as `src`), containing a deep c
|
|
|
323
323
|
|
|
324
324
|
> **copy**\<`T`\>(`dst`, `src`): `boolean`
|
|
325
325
|
|
|
326
|
-
Defined in: [aberdeen.ts:1535](https://github.com/vanviegen/aberdeen/blob/
|
|
326
|
+
Defined in: [aberdeen.ts:1535](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1535)
|
|
327
327
|
|
|
328
328
|
Recursively copies properties or array items from `src` to `dst`.
|
|
329
329
|
It's designed to work efficiently with reactive proxies created by [proxy](#proxy).
|
|
@@ -384,7 +384,7 @@ console.log(dest); // proxy({ a: 1, b: { e: 4 } })
|
|
|
384
384
|
|
|
385
385
|
> **copy**\<`T`\>(`dst`, `dstKey`, `src`): `boolean`
|
|
386
386
|
|
|
387
|
-
Defined in: [aberdeen.ts:1542](https://github.com/vanviegen/aberdeen/blob/
|
|
387
|
+
Defined in: [aberdeen.ts:1542](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1542)
|
|
388
388
|
|
|
389
389
|
Like above, but copies `src` into `dst[dstKey]`. This is useful if you're unsure if dst[dstKey]
|
|
390
390
|
already exists (as the right type of object) or if you don't want to subscribe to dst[dstKey].
|
|
@@ -421,7 +421,7 @@ Optional key in `dst` to copy into.
|
|
|
421
421
|
|
|
422
422
|
> **count**(`proxied`): `ValueRef`\<`number`\>
|
|
423
423
|
|
|
424
|
-
Defined in: [aberdeen.ts:1057](https://github.com/vanviegen/aberdeen/blob/
|
|
424
|
+
Defined in: [aberdeen.ts:1057](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1057)
|
|
425
425
|
|
|
426
426
|
Reactively counts the number of properties in an objects.
|
|
427
427
|
|
|
@@ -466,7 +466,7 @@ items.z = 12;
|
|
|
466
466
|
|
|
467
467
|
> **darkMode**(): `boolean`
|
|
468
468
|
|
|
469
|
-
Defined in: [aberdeen.ts:
|
|
469
|
+
Defined in: [aberdeen.ts:1850](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1850)
|
|
470
470
|
|
|
471
471
|
Returns whether the user's browser prefers a dark color scheme.
|
|
472
472
|
|
|
@@ -501,7 +501,7 @@ $('div bg:$bg fg:$fg p:1rem #Colors change based on system dark mode preference'
|
|
|
501
501
|
|
|
502
502
|
> **derive**\<`T`\>(`func`): `ValueRef`\<`T`\>
|
|
503
503
|
|
|
504
|
-
Defined in: [aberdeen.ts:
|
|
504
|
+
Defined in: [aberdeen.ts:2686](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2686)
|
|
505
505
|
|
|
506
506
|
Creates a reactive scope that automatically re-executes the provided function
|
|
507
507
|
whenever any proxied data (created by [proxy](#proxy)) read during its last execution changes, storing
|
|
@@ -570,7 +570,7 @@ $('h3', () => {
|
|
|
570
570
|
|
|
571
571
|
> **dump**\<`T`\>(`data`): `T`
|
|
572
572
|
|
|
573
|
-
Defined in: [aberdeen.ts:
|
|
573
|
+
Defined in: [aberdeen.ts:3107](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L3107)
|
|
574
574
|
|
|
575
575
|
Renders a live, recursive dump of a proxied data structure (or any value)
|
|
576
576
|
into the DOM at the current [$](#) insertion point.
|
|
@@ -623,7 +623,7 @@ setTimeout(() => { state.user.kids++; state.items.push('c'); }, 2000);
|
|
|
623
623
|
|
|
624
624
|
> **insertCss**(`style`): `string`
|
|
625
625
|
|
|
626
|
-
Defined in: [aberdeen.ts:
|
|
626
|
+
Defined in: [aberdeen.ts:2327](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2327)
|
|
627
627
|
|
|
628
628
|
Inserts CSS rules into the document, scoping them with a unique class name.
|
|
629
629
|
|
|
@@ -708,7 +708,7 @@ $(badge + ' span#Product Name');
|
|
|
708
708
|
|
|
709
709
|
> **insertGlobalCss**(`style`): `void`
|
|
710
710
|
|
|
711
|
-
Defined in: [aberdeen.ts:
|
|
711
|
+
Defined in: [aberdeen.ts:2463](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2463)
|
|
712
712
|
|
|
713
713
|
Inserts CSS rules globally (unscoped).
|
|
714
714
|
|
|
@@ -769,7 +769,7 @@ insertGlobalCss({
|
|
|
769
769
|
|
|
770
770
|
> **invertString**(`input`): `string`
|
|
771
771
|
|
|
772
|
-
Defined in: [aberdeen.ts:149](https://github.com/vanviegen/aberdeen/blob/
|
|
772
|
+
Defined in: [aberdeen.ts:149](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L149)
|
|
773
773
|
|
|
774
774
|
Creates a new string that has the opposite sort order compared to the input string.
|
|
775
775
|
|
|
@@ -818,7 +818,7 @@ onEach(users, (user) => {
|
|
|
818
818
|
|
|
819
819
|
> **isEmpty**(`proxied`): `boolean`
|
|
820
820
|
|
|
821
|
-
Defined in: [aberdeen.ts:997](https://github.com/vanviegen/aberdeen/blob/
|
|
821
|
+
Defined in: [aberdeen.ts:997](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L997)
|
|
822
822
|
|
|
823
823
|
Reactively checks if an observable array or object is empty.
|
|
824
824
|
|
|
@@ -920,7 +920,7 @@ users.u2.active = true;
|
|
|
920
920
|
|
|
921
921
|
> **map**\<`K`, `IN`, `OUT`\>(`source`, `func`): `Map`\<`K`, `OUT`\>
|
|
922
922
|
|
|
923
|
-
Defined in: [aberdeen.ts:
|
|
923
|
+
Defined in: [aberdeen.ts:2794](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2794)
|
|
924
924
|
|
|
925
925
|
When using a Map as `source`.
|
|
926
926
|
|
|
@@ -956,7 +956,7 @@ When using a Map as `source`.
|
|
|
956
956
|
|
|
957
957
|
> **map**\<`IN`, `OUT`\>(`source`, `func`): `OUT`[]
|
|
958
958
|
|
|
959
|
-
Defined in: [aberdeen.ts:
|
|
959
|
+
Defined in: [aberdeen.ts:2799](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2799)
|
|
960
960
|
|
|
961
961
|
When using an array as `source`.
|
|
962
962
|
|
|
@@ -988,7 +988,7 @@ When using an array as `source`.
|
|
|
988
988
|
|
|
989
989
|
> **map**\<`IN`, `IN_KEY`, `OUT`\>(`source`, `func`): `Record`\<`string` \| `symbol`, `OUT`\>
|
|
990
990
|
|
|
991
|
-
Defined in: [aberdeen.ts:
|
|
991
|
+
Defined in: [aberdeen.ts:2804](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2804)
|
|
992
992
|
|
|
993
993
|
When using an object as `source`.
|
|
994
994
|
|
|
@@ -1028,7 +1028,7 @@ When using an object as `source`.
|
|
|
1028
1028
|
|
|
1029
1029
|
> **merge**\<`T`\>(`dst`, `value`): `boolean`
|
|
1030
1030
|
|
|
1031
|
-
Defined in: [aberdeen.ts:1575](https://github.com/vanviegen/aberdeen/blob/
|
|
1031
|
+
Defined in: [aberdeen.ts:1575](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1575)
|
|
1032
1032
|
|
|
1033
1033
|
Like [copy](#copy), but uses merge semantics. Properties in `dst` not present in `src` are kept.
|
|
1034
1034
|
`null`/`undefined` in `src` delete properties in `dst`.
|
|
@@ -1068,7 +1068,7 @@ console.log(dest); // proxy({ a: 1, b: { c: 99, x: 5, y: 6 }, c: { z: 7 } })
|
|
|
1068
1068
|
|
|
1069
1069
|
> **merge**\<`T`\>(`dst`, `dstKey`, `value`): `boolean`
|
|
1070
1070
|
|
|
1071
|
-
Defined in: [aberdeen.ts:1576](https://github.com/vanviegen/aberdeen/blob/
|
|
1071
|
+
Defined in: [aberdeen.ts:1576](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1576)
|
|
1072
1072
|
|
|
1073
1073
|
Like [copy](#copy), but uses merge semantics. Properties in `dst` not present in `src` are kept.
|
|
1074
1074
|
`null`/`undefined` in `src` delete properties in `dst`.
|
|
@@ -1114,7 +1114,7 @@ console.log(dest); // proxy({ a: 1, b: { c: 99, x: 5, y: 6 }, c: { z: 7 } })
|
|
|
1114
1114
|
|
|
1115
1115
|
> **mount**(`parentElement`, `func`): `void`
|
|
1116
1116
|
|
|
1117
|
-
Defined in: [aberdeen.ts:
|
|
1117
|
+
Defined in: [aberdeen.ts:2733](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2733)
|
|
1118
1118
|
|
|
1119
1119
|
Attaches a reactive Aberdeen UI fragment to an existing DOM element. Without the use of
|
|
1120
1120
|
this function, [$](#) will assume `document.body` as its root.
|
|
@@ -1232,7 +1232,7 @@ items.push({ id: 'c', value: 30 });
|
|
|
1232
1232
|
|
|
1233
1233
|
> **multiMap**\<`IN`, `OUT`\>(`source`, `func`): `OUT`
|
|
1234
1234
|
|
|
1235
|
-
Defined in: [aberdeen.ts:
|
|
1235
|
+
Defined in: [aberdeen.ts:2884](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2884)
|
|
1236
1236
|
|
|
1237
1237
|
When using an array as `source`.
|
|
1238
1238
|
|
|
@@ -1264,7 +1264,7 @@ When using an array as `source`.
|
|
|
1264
1264
|
|
|
1265
1265
|
> **multiMap**\<`K`, `IN`, `OUT`\>(`source`, `func`): `OUT`
|
|
1266
1266
|
|
|
1267
|
-
Defined in: [aberdeen.ts:
|
|
1267
|
+
Defined in: [aberdeen.ts:2889](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2889)
|
|
1268
1268
|
|
|
1269
1269
|
When using an object as `source`.
|
|
1270
1270
|
|
|
@@ -1300,7 +1300,7 @@ When using an object as `source`.
|
|
|
1300
1300
|
|
|
1301
1301
|
> **multiMap**\<`K`, `IN`, `OUT`\>(`source`, `func`): `OUT`
|
|
1302
1302
|
|
|
1303
|
-
Defined in: [aberdeen.ts:
|
|
1303
|
+
Defined in: [aberdeen.ts:2895](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2895)
|
|
1304
1304
|
|
|
1305
1305
|
When using a Map as `source`.
|
|
1306
1306
|
|
|
@@ -1404,7 +1404,7 @@ setTimeout(() => config.fontSize = 16, 2000);
|
|
|
1404
1404
|
|
|
1405
1405
|
> **onEach**\<`K`, `T`\>(`target`, `render`, `makeKey?`): `void`
|
|
1406
1406
|
|
|
1407
|
-
Defined in: [aberdeen.ts:875](https://github.com/vanviegen/aberdeen/blob/
|
|
1407
|
+
Defined in: [aberdeen.ts:875](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L875)
|
|
1408
1408
|
|
|
1409
1409
|
##### Type Parameters
|
|
1410
1410
|
|
|
@@ -1438,7 +1438,7 @@ Defined in: [aberdeen.ts:875](https://github.com/vanviegen/aberdeen/blob/876d65e
|
|
|
1438
1438
|
|
|
1439
1439
|
> **onEach**\<`T`\>(`target`, `render`, `makeKey?`): `void`
|
|
1440
1440
|
|
|
1441
|
-
Defined in: [aberdeen.ts:880](https://github.com/vanviegen/aberdeen/blob/
|
|
1441
|
+
Defined in: [aberdeen.ts:880](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L880)
|
|
1442
1442
|
|
|
1443
1443
|
##### Type Parameters
|
|
1444
1444
|
|
|
@@ -1468,7 +1468,7 @@ readonly (`undefined` \| `T`)[]
|
|
|
1468
1468
|
|
|
1469
1469
|
> **onEach**\<`K`, `T`\>(`target`, `render`, `makeKey?`): `void`
|
|
1470
1470
|
|
|
1471
|
-
Defined in: [aberdeen.ts:885](https://github.com/vanviegen/aberdeen/blob/
|
|
1471
|
+
Defined in: [aberdeen.ts:885](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L885)
|
|
1472
1472
|
|
|
1473
1473
|
##### Type Parameters
|
|
1474
1474
|
|
|
@@ -1581,7 +1581,7 @@ console.log(usersByTag);
|
|
|
1581
1581
|
|
|
1582
1582
|
> **partition**\<`OUT_K`, `IN_V`\>(`source`, `func`): `Record`\<`OUT_K`, `Record`\<`number`, `IN_V`\>\>
|
|
1583
1583
|
|
|
1584
|
-
Defined in: [aberdeen.ts:
|
|
1584
|
+
Defined in: [aberdeen.ts:2959](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2959)
|
|
1585
1585
|
|
|
1586
1586
|
When using an object as `array`.
|
|
1587
1587
|
|
|
@@ -1613,7 +1613,7 @@ When using an object as `array`.
|
|
|
1613
1613
|
|
|
1614
1614
|
> **partition**\<`IN_K`, `OUT_K`, `IN_V`\>(`source`, `func`): `Record`\<`OUT_K`, `Record`\<`IN_K`, `IN_V`\>\>
|
|
1615
1615
|
|
|
1616
|
-
Defined in: [aberdeen.ts:
|
|
1616
|
+
Defined in: [aberdeen.ts:2964](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2964)
|
|
1617
1617
|
|
|
1618
1618
|
When using an object as `source`.
|
|
1619
1619
|
|
|
@@ -1649,7 +1649,7 @@ When using an object as `source`.
|
|
|
1649
1649
|
|
|
1650
1650
|
> **partition**\<`IN_K`, `OUT_K`, `IN_V`\>(`source`, `func`): `Record`\<`OUT_K`, `Record`\<`IN_K`, `IN_V`\>\>
|
|
1651
1651
|
|
|
1652
|
-
Defined in: [aberdeen.ts:
|
|
1652
|
+
Defined in: [aberdeen.ts:2973](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2973)
|
|
1653
1653
|
|
|
1654
1654
|
When using a Map as `source`.
|
|
1655
1655
|
|
|
@@ -1689,7 +1689,7 @@ When using a Map as `source`.
|
|
|
1689
1689
|
|
|
1690
1690
|
> **peek**\<`T`, `K`\>(`target`, `key`): `T`\[`K`\]
|
|
1691
1691
|
|
|
1692
|
-
Defined in: [aberdeen.ts:
|
|
1692
|
+
Defined in: [aberdeen.ts:2775](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2775)
|
|
1693
1693
|
|
|
1694
1694
|
Executes a function or retrieves a value *without* creating subscriptions in the current reactive scope, and returns its result.
|
|
1695
1695
|
|
|
@@ -1745,7 +1745,7 @@ data.a = 2; // Triggers console.log (logs "A is 2, B was 3 when A changed.")
|
|
|
1745
1745
|
|
|
1746
1746
|
> **peek**\<`K`, `V`\>(`target`, `key`): `undefined` \| `V`
|
|
1747
1747
|
|
|
1748
|
-
Defined in: [aberdeen.ts:
|
|
1748
|
+
Defined in: [aberdeen.ts:2776](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2776)
|
|
1749
1749
|
|
|
1750
1750
|
Executes a function or retrieves a value *without* creating subscriptions in the current reactive scope, and returns its result.
|
|
1751
1751
|
|
|
@@ -1801,7 +1801,7 @@ data.a = 2; // Triggers console.log (logs "A is 2, B was 3 when A changed.")
|
|
|
1801
1801
|
|
|
1802
1802
|
> **peek**\<`T`\>(`target`, `key`): `undefined` \| `T`
|
|
1803
1803
|
|
|
1804
|
-
Defined in: [aberdeen.ts:
|
|
1804
|
+
Defined in: [aberdeen.ts:2777](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2777)
|
|
1805
1805
|
|
|
1806
1806
|
Executes a function or retrieves a value *without* creating subscriptions in the current reactive scope, and returns its result.
|
|
1807
1807
|
|
|
@@ -1853,7 +1853,7 @@ data.a = 2; // Triggers console.log (logs "A is 2, B was 3 when A changed.")
|
|
|
1853
1853
|
|
|
1854
1854
|
> **peek**\<`T`\>(`target`): `T`
|
|
1855
1855
|
|
|
1856
|
-
Defined in: [aberdeen.ts:
|
|
1856
|
+
Defined in: [aberdeen.ts:2778](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2778)
|
|
1857
1857
|
|
|
1858
1858
|
Executes a function or retrieves a value *without* creating subscriptions in the current reactive scope, and returns its result.
|
|
1859
1859
|
|
|
@@ -1961,7 +1961,7 @@ setTimeout(() => graph.grow(), 4000);
|
|
|
1961
1961
|
|
|
1962
1962
|
> **proxy**\<`T`\>(`target`): [`PromiseProxy`](#promiseproxy)\<`T`\>
|
|
1963
1963
|
|
|
1964
|
-
Defined in: [aberdeen.ts:1375](https://github.com/vanviegen/aberdeen/blob/
|
|
1964
|
+
Defined in: [aberdeen.ts:1375](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1375)
|
|
1965
1965
|
|
|
1966
1966
|
##### Type Parameters
|
|
1967
1967
|
|
|
@@ -1983,7 +1983,7 @@ Defined in: [aberdeen.ts:1375](https://github.com/vanviegen/aberdeen/blob/876d65
|
|
|
1983
1983
|
|
|
1984
1984
|
> **proxy**\<`T`\>(`target`): `T` *extends* `number` ? `number` : `T` *extends* `string` ? `string` : `T` *extends* `boolean` ? `boolean` : `T`[]
|
|
1985
1985
|
|
|
1986
|
-
Defined in: [aberdeen.ts:1376](https://github.com/vanviegen/aberdeen/blob/
|
|
1986
|
+
Defined in: [aberdeen.ts:1376](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1376)
|
|
1987
1987
|
|
|
1988
1988
|
##### Type Parameters
|
|
1989
1989
|
|
|
@@ -2005,7 +2005,7 @@ Defined in: [aberdeen.ts:1376](https://github.com/vanviegen/aberdeen/blob/876d65
|
|
|
2005
2005
|
|
|
2006
2006
|
> **proxy**\<`T`\>(`target`): `T`
|
|
2007
2007
|
|
|
2008
|
-
Defined in: [aberdeen.ts:1377](https://github.com/vanviegen/aberdeen/blob/
|
|
2008
|
+
Defined in: [aberdeen.ts:1377](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1377)
|
|
2009
2009
|
|
|
2010
2010
|
##### Type Parameters
|
|
2011
2011
|
|
|
@@ -2027,7 +2027,7 @@ Defined in: [aberdeen.ts:1377](https://github.com/vanviegen/aberdeen/blob/876d65
|
|
|
2027
2027
|
|
|
2028
2028
|
> **proxy**\<`T`\>(`target`): `ValueRef`\<`T` *extends* `number` ? `number` : `T` *extends* `string` ? `string` : `T` *extends* `boolean` ? `boolean` : `T`\>
|
|
2029
2029
|
|
|
2030
|
-
Defined in: [aberdeen.ts:1378](https://github.com/vanviegen/aberdeen/blob/
|
|
2030
|
+
Defined in: [aberdeen.ts:1378](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1378)
|
|
2031
2031
|
|
|
2032
2032
|
##### Type Parameters
|
|
2033
2033
|
|
|
@@ -2051,7 +2051,7 @@ Defined in: [aberdeen.ts:1378](https://github.com/vanviegen/aberdeen/blob/876d65
|
|
|
2051
2051
|
|
|
2052
2052
|
> **ref**\<`T`, `K`\>(`target`, `index`): `ValueRef`\<`T`\[`K`\]\>
|
|
2053
2053
|
|
|
2054
|
-
Defined in: [aberdeen.ts:
|
|
2054
|
+
Defined in: [aberdeen.ts:1932](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1932)
|
|
2055
2055
|
|
|
2056
2056
|
Creates a reactive reference (`{ value: T }`-like object) to a specific value
|
|
2057
2057
|
within a proxied object or array.
|
|
@@ -2113,7 +2113,7 @@ $(() => console.log(formData))
|
|
|
2113
2113
|
|
|
2114
2114
|
> **runQueue**(): `void`
|
|
2115
2115
|
|
|
2116
|
-
Defined in: [aberdeen.ts:69](https://github.com/vanviegen/aberdeen/blob/
|
|
2116
|
+
Defined in: [aberdeen.ts:69](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L69)
|
|
2117
2117
|
|
|
2118
2118
|
Forces the immediate and synchronous execution of all pending reactive updates.
|
|
2119
2119
|
|
|
@@ -2156,7 +2156,7 @@ console.log(2, document.body.innerHTML); // after
|
|
|
2156
2156
|
|
|
2157
2157
|
> **setErrorHandler**(`handler?`): `void`
|
|
2158
2158
|
|
|
2159
|
-
Defined in: [aberdeen.ts:
|
|
2159
|
+
Defined in: [aberdeen.ts:2590](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2590)
|
|
2160
2160
|
|
|
2161
2161
|
Sets a custom error handler function for errors that occur asynchronously
|
|
2162
2162
|
within reactive scopes (e.g., during updates triggered by proxy changes in
|
|
@@ -2216,7 +2216,7 @@ $('div.box', () => {
|
|
|
2216
2216
|
|
|
2217
2217
|
> **setSpacingCssVars**(`base`, `unit`): `void`
|
|
2218
2218
|
|
|
2219
|
-
Defined in: [aberdeen.ts:1800](https://github.com/vanviegen/aberdeen/blob/
|
|
2219
|
+
Defined in: [aberdeen.ts:1800](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1800)
|
|
2220
2220
|
|
|
2221
2221
|
Initializes `cssVars[0]` through `cssVars[12]` with an exponential spacing scale.
|
|
2222
2222
|
|
|
@@ -2265,7 +2265,7 @@ onEach(cssVars, (value, key) => {
|
|
|
2265
2265
|
|
|
2266
2266
|
> **unmountAll**(): `void`
|
|
2267
2267
|
|
|
2268
|
-
Defined in: [aberdeen.ts:
|
|
2268
|
+
Defined in: [aberdeen.ts:2744](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L2744)
|
|
2269
2269
|
|
|
2270
2270
|
Removes all Aberdeen-managed DOM nodes and stops all active reactive scopes
|
|
2271
2271
|
(created by [mount](#mount), [derive](#derive), [$](#) with functions, etc.).
|
|
@@ -2283,7 +2283,7 @@ automated tests, there should probably be little reason to call this function.
|
|
|
2283
2283
|
|
|
2284
2284
|
> **unproxy**\<`T`\>(`target`): `T`
|
|
2285
2285
|
|
|
2286
|
-
Defined in: [aberdeen.ts:1492](https://github.com/vanviegen/aberdeen/blob/
|
|
2286
|
+
Defined in: [aberdeen.ts:1492](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/aberdeen.ts#L1492)
|
|
2287
2287
|
|
|
2288
2288
|
Returns the original, underlying data target from a reactive proxy created by [proxy](#proxy).
|
|
2289
2289
|
If the input `target` is not a proxy, it is returned directly.
|
package/skill/dispatcher.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**Aberdeen v1.7.
|
|
1
|
+
[**Aberdeen v1.7.2**](README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
### Dispatcher
|
|
12
12
|
|
|
13
|
-
Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/
|
|
13
|
+
Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/dispatcher.ts#L61)
|
|
14
14
|
|
|
15
15
|
Simple route matcher and dispatcher.
|
|
16
16
|
|
|
@@ -53,7 +53,7 @@ dispatcher.dispatch(["search", "classical", "piano"]);
|
|
|
53
53
|
|
|
54
54
|
> **addRoute**\<`T`, `H`\>(...`args`): `void`
|
|
55
55
|
|
|
56
|
-
Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/
|
|
56
|
+
Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/dispatcher.ts#L73)
|
|
57
57
|
|
|
58
58
|
Add a route with matchers and a handler function.
|
|
59
59
|
|
|
@@ -90,7 +90,7 @@ An array of matchers followed by a handler function. Each matcher can be:
|
|
|
90
90
|
|
|
91
91
|
> **dispatch**(`segments`): `boolean`
|
|
92
92
|
|
|
93
|
-
Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/
|
|
93
|
+
Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/dispatcher.ts#L94)
|
|
94
94
|
|
|
95
95
|
Dispatches the given segments to the first route handler that matches.
|
|
96
96
|
|
|
@@ -114,7 +114,7 @@ True if a matching route was found and handled, false otherwise.
|
|
|
114
114
|
|
|
115
115
|
> `const` **MATCH\_FAILED**: unique `symbol`
|
|
116
116
|
|
|
117
|
-
Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/
|
|
117
|
+
Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/dispatcher.ts#L4)
|
|
118
118
|
|
|
119
119
|
Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot match a segment.
|
|
120
120
|
|
|
@@ -124,6 +124,6 @@ Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot m
|
|
|
124
124
|
|
|
125
125
|
> `const` **MATCH\_REST**: unique `symbol`
|
|
126
126
|
|
|
127
|
-
Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/
|
|
127
|
+
Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/dispatcher.ts#L9)
|
|
128
128
|
|
|
129
129
|
Special [Dispatcher.addRoute](#addroute) matcher that matches the rest of the segments as an array of strings.
|
package/skill/prediction.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**Aberdeen v1.7.
|
|
1
|
+
[**Aberdeen v1.7.2**](README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
> **applyCanon**(`canonFunc?`, `dropPredictions?`): `void`
|
|
14
14
|
|
|
15
|
-
Defined in: [prediction.ts:115](https://github.com/vanviegen/aberdeen/blob/
|
|
15
|
+
Defined in: [prediction.ts:115](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/prediction.ts#L115)
|
|
16
16
|
|
|
17
17
|
Temporarily revert all outstanding predictions, optionally run the provided function
|
|
18
18
|
(which will generally make authoritative changes to the data based on a server response),
|
|
@@ -50,7 +50,7 @@ An optional list of predictions (as returned by `applyPrediction`)
|
|
|
50
50
|
|
|
51
51
|
> **applyPrediction**(`predictFunc`): `Patch`
|
|
52
52
|
|
|
53
|
-
Defined in: [prediction.ts:93](https://github.com/vanviegen/aberdeen/blob/
|
|
53
|
+
Defined in: [prediction.ts:93](https://github.com/vanviegen/aberdeen/blob/5343a0b73d29371c35d98f54f8a70608d83576dd/src/prediction.ts#L93)
|
|
54
54
|
|
|
55
55
|
Run the provided function, while treating all changes to Observables as predictions,
|
|
56
56
|
meaning they will be reverted when changes come back from the server (or some other
|