aberdeen 1.17.1 → 2.0.1

package/skill/dispatcher.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.17.1**](README.md)
+[**Aberdeen v2.0.1**](README.md)
 
 ***
 
@@ -10,7 +10,7 @@
 
 ### Dispatcher
 
-Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/dispatcher.ts#L61)
+Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/dispatcher.ts#L61)
 
 Simple route matcher and dispatcher.
 
@@ -37,23 +37,13 @@ dispatcher.dispatch(["search", "classical", "piano"]);
 // Logs: Search terms: [ 'classical', 'piano' ]
 ```
 
-#### Constructors
-
-##### Constructor
-
-> **new Dispatcher**(): [`Dispatcher`](#dispatcher)
-
-###### Returns
-
-[`Dispatcher`](#dispatcher)
-
 #### Methods
 
 ##### addRoute()
 
 > **addRoute**\<`T`, `H`\>(...`args`): `void`
 
-Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/dispatcher.ts#L73)
+Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/dispatcher.ts#L73)
 
 Add a route with matchers and a handler function.
 
@@ -90,7 +80,7 @@ An array of matchers followed by a handler function. Each matcher can be:
 
 > **dispatch**(`segments`): `boolean`
 
-Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/dispatcher.ts#L94)
+Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/dispatcher.ts#L94)
 
 Dispatches the given segments to the first route handler that matches.
 
@@ -114,7 +104,7 @@ True if a matching route was found and handled, false otherwise.
 
 > `const` **MATCH\_FAILED**: unique `symbol`
 
-Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/dispatcher.ts#L4)
+Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/dispatcher.ts#L4)
 
 Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot match a segment.
 
@@ -124,6 +114,6 @@ Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot m
 
 > `const` **MATCH\_REST**: unique `symbol`
 
-Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/dispatcher.ts#L9)
+Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/dispatcher.ts#L9)
 
 Special [Dispatcher.addRoute](#addroute) matcher that matches the rest of the segments as an array of strings.

package/skill/prediction.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.17.1**](README.md)
+[**Aberdeen v2.0.1**](README.md)
 
 ***
 
@@ -10,9 +10,9 @@
 
 ### applyCanon()
 
-> **applyCanon**(`canonFunc?`, `dropPredictions?`): `void`
+> **applyCanon**(`A`, `canonFunc?`, `dropPredictions?`): `void`
 
-Defined in: [prediction.ts:136](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/prediction.ts#L136)
+Defined in: [prediction.ts:136](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/prediction.ts#L136)
 
 Temporarily revert all outstanding predictions, optionally run the provided function
 (which will generally make authoritative changes to the data based on a server response),
@@ -25,6 +25,12 @@ actual change to an `Observable`.
 
 #### Parameters
 
+##### A
+
+`any`
+
+The Aberdeen instance (the default export of `aberdeen`, or one from `init`).
+
 ##### canonFunc?
 
 () => `void`
@@ -48,9 +54,9 @@ An optional list of predictions (as returned by `applyPrediction`)
 
 ### applyPrediction()
 
-> **applyPrediction**(`predictFunc`): `Patch`
+> **applyPrediction**(`A`, `predictFunc`): `Patch`
 
-Defined in: [prediction.ts:114](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/prediction.ts#L114)
+Defined in: [prediction.ts:113](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/prediction.ts#L113)
 
 Run the provided function, while treating all changes to Observables as predictions,
 meaning they will be reverted when changes come back from the server (or some other
@@ -58,6 +64,12 @@ async source).
 
 #### Parameters
 
+##### A
+
+`any`
+
+The Aberdeen instance (the default export of `aberdeen`, or one from `init`).
+
 ##### predictFunc
 
 () => `void`

package/skill/route.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.17.1**](README.md)
+[**Aberdeen v2.0.1**](README.md)
 
 ***
 
@@ -8,128 +8,63 @@
 
 ## Interfaces
 
-### Route
+### RouteApi
 
-Defined in: [route.ts:8](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L8)
+Defined in: [route.ts:39](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L39)
 
-The class for the global `route` object.
+The router API returned by [createRoute](#createroute), bound to a specific Aberdeen instance's window.
 
 #### Properties
 
-##### depth
-
-> **depth**: `number`
-
-Defined in: [route.ts:20](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L20)
-
-The navigation depth of the current session. Starts at 1. Writing to this property has no effect.
-
-##### hash
-
-> **hash**: `string`
-
-Defined in: [route.ts:14](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L14)
-
-The hash fragment including the leading `#`, or an empty string. For instance `"#my_section"` or `""`.
-
-##### nav
-
-> **nav**: `NavType`
-
-Defined in: [route.ts:28](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L28)
-
-The navigation action that got us to this page. Writing to this property has no effect.
-- `"load"`: An initial page load.
-- `"back"` or `"forward"`: When we navigated backwards or forwards in the stack.
-- `"go"`: When we added a new page on top of the stack.
-- `"push"`: When we added a new page on top of the stack, merging with the current page.
-Mostly useful for page transition animations. Writing to this property has no effect.
-
-##### p
-
-> **p**: `string`[]
-
-Defined in: [route.ts:12](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L12)
-
-An convenience array containing path segments, mapping to `path`. For instance `[]` (for `"/"`) or `['users', '123', 'feed']` (for `"/users/123/feed"`).
-
-##### path
-
-> **path**: `string`
-
-Defined in: [route.ts:10](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L10)
-
-The current path of the URL as a string. For instance `"/"` or `"/users/123/feed"`. Paths are normalized to always start with a `/` and never end with a `/` (unless it's the root path).
-
-##### search
-
-> **search**: `Record`\<`string`, `string`\>
+##### current
 
-Defined in: [route.ts:16](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L16)
+> **current**: [`RouteState`](#routestate)
 
-The query string interpreted as search parameters. So `"a=x&b=y"` becomes `{a: "x", b: "y"}`.
-
-##### state
-
-> **state**: `Record`\<`string`, `any`\>
-
-Defined in: [route.ts:18](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L18)
-
-An object to be used for any additional data you want to associate with the current page. Data should be JSON-compatible.
+Defined in: [route.ts:43](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L43)
 
-## Variables
+The global [RouteState](#routestate) object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
 
-### current
+#### Methods
 
-> `const` **current**: [`Route`](#route)
+##### back()
 
-Defined in: [route.ts:312](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L312)
+> **back**(`target?`): `void`
 
-The global [Route](#route) object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
-
-## Functions
-
-### back()
-
-> **back**(`target`): `void`
-
-Defined in: [route.ts:246](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L246)
+Defined in: [route.ts:108](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L108)
 
 Try to go back in history to the first entry that matches the given target. If none is found, the given state will replace the current page. This is useful for "cancel" or "close" actions that should return to the previous page if possible, but create a new page if not (for instance when arriving at the current page through a direct link).
 
 Consider using [up](#up) to go up in the path hierarchy.
 
-#### Parameters
+###### Parameters
 
-##### target
+###### target?
 
-`RouteTarget` = `{}`
+`RouteTarget`
 
-The target route to go back to. May be a subset of [Route](#route), or a string (for `path`), or an array of strings (for `p`).
+The target route to go back to. May be a subset of [RouteState](#routestate), or a string (for `path`), or an array of strings (for `p`).
 
-#### Returns
+###### Returns
 
 `void`
 
-***
-
-### go()
+##### go()
 
-> **go**(`target`, `nav`): `void`
+> **go**(`target`, `nav?`): `void`
 
-Defined in: [route.ts:170](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L170)
+Defined in: [route.ts:69](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L69)
 
 Navigate to a new URL by pushing a new history entry.
 
 Note that this happens synchronously, immediately updating `route` and processing any reactive updates based on that.
 
-#### Parameters
+###### Parameters
 
-##### target
+###### target
 
 `RouteTarget`
 
-A subset of the [Route](#route) properties to navigate to. If neither `p` nor `path` is given, the current path is used. For other properties, an empty/default value is assumed if not given. For convenience:
+A subset of the [RouteState](#routestate) properties to navigate to. If neither `p` nor `path` is given, the current path is used. For other properties, an empty/default value is assumed if not given. For convenience:
 - You may pass a string instead of an object, which is interpreted as the `path`.
 - You may pass an array instead of an object, which is interpreted as the `p` array.
 - If you pass `p`, it may contain numbers, which will be converted to strings.
@@ -144,21 +79,19 @@ route.go("/users/123");
 route.go({p: ["users", 123], search: {tab: "feed"}, hash: "top"});
 ```
 
-##### nav
+###### nav?
 
-`NavType` = `"go"`
+`NavType`
 
-#### Returns
+###### Returns
 
 `void`
 
-***
-
-### interceptLinks()
+##### interceptLinks()
 
 > **interceptLinks**(): `void`
 
-Defined in: [route.ts:432](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L432)
+Defined in: [route.ts:145](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L145)
 
 Intercept clicks and Enter key presses on links (`<a>` tags) and use Aberdeen routing
 instead of browser navigation for local paths (paths without a protocol or host).
@@ -166,11 +99,11 @@ instead of browser navigation for local paths (paths without a protocol or host)
 This allows you to use regular HTML anchor tags for navigation without needing to
 manually attach click handlers to each link.
 
-#### Returns
+###### Returns
 
 `void`
 
-#### Example
+###### Example
 
 ```js
 // In your root component:
@@ -180,13 +113,11 @@ route.interceptLinks();
 A('a text=About href=/corporate/about');
 ```
 
-***
-
-### matchCurrent()
+##### matchCurrent()
 
 > **matchCurrent**(`target`): `boolean`
 
-Defined in: [route.ts:205](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L205)
+Defined in: [route.ts:90](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L90)
 
 Returns `true` if the current route matches `target`.
 
@@ -198,17 +129,17 @@ when target k/v search pairs are (un)set.
 
 Primary usage: 'active' status for menu items.
 
-#### Parameters
+###### Parameters
 
-##### target
+###### target
 
 `RouteTarget`
 
-#### Returns
+###### Returns
 
 `boolean`
 
-#### Example
+###### Example
 
 ```js
 // This example assumes interceptLinks() has been called
@@ -218,92 +149,84 @@ A('a.my-button text=Users href=/users .is-active=', route.matchCurrent('/users')
 route.matchCurrent({path: '/users', search: {tab: 'profile'}});
 ```
 
-***
-
-### persistScroll()
+##### persistScroll()
 
-> **persistScroll**(`name`): `void`
+> **persistScroll**(`name?`): `void`
 
-Defined in: [route.ts:398](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L398)
+Defined in: [route.ts:128](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L128)
 
 Restore and store the vertical and horizontal scroll position for
 the parent element to the page state.
 
-#### Parameters
+###### Parameters
 
-##### name
+###### name?
 
-`string` = `"main"`
+`string`
 
 A unique (within this page) name for this
 scrollable element. Defaults to 'main'.
 
 The scroll position will be persisted in `route.aux.scroll.<name>`.
 
-#### Returns
+###### Returns
 
 `void`
 
-***
-
-### push()
+##### push()
 
 > **push**(`target`, `nav?`): `void`
 
-Defined in: [route.ts:233](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L233)
+Defined in: [route.ts:100](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L100)
 
 Modify the current route by merging `target` into it (using [A.merge](aberdeen.md#merge)), pushing a new history entry.
 
 This is useful for things like opening modals or side panels, where you want a browser back action to return to the previous state.
 
-#### Parameters
+###### Parameters
 
-##### target
+###### target
 
 `RouteTarget`
 
 Same as for [go](#go), but merged into the current route instead deleting all state.
 
-##### nav?
+###### nav?
 
 `NavType`
 
 The navigation type to use. Defaults to `undefined`, meaning the navigation type is unchanged from the current route,
  preventing unwanted page transition animations.
 
-#### Returns
+###### Returns
 
 `void`
 
-***
-
-### setLog()
+##### setLog()
 
 > **setLog**(`value`): `void`
 
-Defined in: [route.ts:37](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L37)
+Defined in: [route.ts:48](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L48)
 
 Configure logging on route changes.
 
-#### Parameters
+###### Parameters
 
-##### value
+###### value
 
 `true` to enable logging to console, `false` to disable logging, or a custom logging function. Defaults to `false`.
 
 `boolean` | (...`args`) => `void`
 
-#### Returns
+###### Returns
 
 `void`
 
-***
-
-### up()
+##### up()
 
-> **up**(`stripCount`): `void`
+> **up**(`stripCount?`): `void`
 
-Defined in: [route.ts:272](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/route.ts#L272)
+Defined in: [route.ts:116](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L116)
 
 Navigate up in the path hierarchy, by going back to the first history entry
 that has a shorter path than the current one. If there's none, we just shorten
@@ -311,12 +234,107 @@ the current path.
 
 Note that going back in browser history happens asynchronously, so `route` will not be updated immediately.
 
+###### Parameters
+
+###### stripCount?
+
+`number`
+
+###### Returns
+
+`void`
+
+***
+
+### RouteState
+
+Defined in: [route.ts:6](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L6)
+
+The class for the global `route` object.
+
+#### Properties
+
+##### depth
+
+> **depth**: `number`
+
+Defined in: [route.ts:18](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L18)
+
+The navigation depth of the current session. Starts at 1. Writing to this property has no effect.
+
+##### hash
+
+> **hash**: `string`
+
+Defined in: [route.ts:12](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L12)
+
+The hash fragment including the leading `#`, or an empty string. For instance `"#my_section"` or `""`.
+
+##### nav
+
+> **nav**: `NavType`
+
+Defined in: [route.ts:26](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L26)
+
+The navigation action that got us to this page. Writing to this property has no effect.
+- `"load"`: An initial page load.
+- `"back"` or `"forward"`: When we navigated backwards or forwards in the stack.
+- `"go"`: When we added a new page on top of the stack.
+- `"push"`: When we added a new page on top of the stack, merging with the current page.
+Mostly useful for page transition animations. Writing to this property has no effect.
+
+##### p
+
+> **p**: `string`[]
+
+Defined in: [route.ts:10](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L10)
+
+An convenience array containing path segments, mapping to `path`. For instance `[]` (for `"/"`) or `['users', '123', 'feed']` (for `"/users/123/feed"`).
+
+##### path
+
+> **path**: `string`
+
+Defined in: [route.ts:8](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L8)
+
+The current path of the URL as a string. For instance `"/"` or `"/users/123/feed"`. Paths are normalized to always start with a `/` and never end with a `/` (unless it's the root path).
+
+##### search
+
+> **search**: `Record`\<`string`, `string`\>
+
+Defined in: [route.ts:14](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L14)
+
+The query string interpreted as search parameters. So `"a=x&b=y"` becomes `{a: "x", b: "y"}`.
+
+##### state
+
+> **state**: `Record`\<`string`, `any`\>
+
+Defined in: [route.ts:16](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L16)
+
+An object to be used for any additional data you want to associate with the current page. Data should be JSON-compatible.
+
+## Functions
+
+### createRoute()
+
+> **createRoute**(`A`): [`RouteApi`](#routeapi)
+
+Defined in: [route.ts:155](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/route.ts#L155)
+
+Initialise routing for an Aberdeen instance and return the router API, bound to that
+instance's window. In the browser, use the default instance: `init(A)`. For server-side
+rendering, pass the instance provided by `aberdeen/server`'s render callback.
+
 #### Parameters
 
-##### stripCount
+##### A
 
-`number` = `1`
+`any`
+
+An Aberdeen instance (the default export of `aberdeen`, or one from `init`).
 
 #### Returns
 
-`void`
+[`RouteApi`](#routeapi)

package/skill/transitions.md

@@ -1,4 +1,4 @@
-[**Aberdeen v1.17.1**](README.md)
+[**Aberdeen v2.0.1**](README.md)
 
 ***
 
@@ -12,7 +12,7 @@
 
 > **grow**(`el`): `Promise`\<`void`\>
 
-Defined in: [transitions.ts:33](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/transitions.ts#L33)
+Defined in: [transitions.ts:39](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/transitions.ts#L39)
 
 Do a grow transition for the given element. This is meant to be used as a
 handler for the `create` property.
@@ -38,7 +38,7 @@ for other specific cases as well.
 
 > **shrink**(`el`): `Promise`\<`void`\>
 
-Defined in: [transitions.ts:56](https://github.com/vanviegen/aberdeen/blob/ceb94aef9d4eaf884e67232de79631a85f543e28/src/transitions.ts#L56)
+Defined in: [transitions.ts:62](https://github.com/vanviegen/aberdeen/blob/b53eddf1a1a2f6ec80ec8518a4cec30e65aa9b96/src/transitions.ts#L62)
 
 Do a shrink transition for the given element, and remove it from the DOM
 afterwards. This is meant to be used as a handler for the `destroy` property.