aberdeen 0.5.0 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 A TypeScript/JavaScript library for quickly building performant declarative user interfaces *without* the use of a virtual DOM.
 
-The key insight is the use of many small anonymous functions, that will automatically rerun when the underlying data changes. In order to trigger updates, that data should be encapsulated in any number of *proxied* JavaScript objects. They can hold anything, from simple values to complex and deeply nested data structures, in which case user-interface functions can (automatically) subscribe to just the parts they depend upon.
+The key insight is the use of many small anonymous functions, that will automatically rerun when the underlying data changes. In order to trigger updates, that data should be encapsulated in any number of *proxied* JavaScript objects. They can hold anything, from simple values to complex, typed and deeply nested data structures, in which case user-interface functions can (automatically) subscribe to just the parts they depend upon.
 
 ## Why use Aberdeen?
 
@@ -165,6 +165,10 @@ Some further examples:
 - [Tutorial](https://vanviegen.github.io/aberdeen/Tutorial/)
 - [Reference documentation](https://vanviegen.github.io/aberdeen/modules.html)
 
+## News
+
+- **2025-5-07**: After five years of working on this library on and off, I'm finally happy with its API and the developer experience it offers. I'm calling it 1.0! To celebrate, I've created some pretty fancy (if I may say so myself) interactive documentation and a tutorial.
+
 ## Roadmap
 
 - [x] Support for (dis)appear transitions.

package/dist/aberdeen.d.ts

@@ -163,7 +163,10 @@ export declare function proxy<T extends DatumType>(target: T): ValueRef<T extend
  * setTimeout(() => rawUser.name += '?', 2000);
  *
  * // Both userProxy and rawUser end up as `{name: 'Frank!?'}`
- * setTimeout(() => console.log('final values', userProxy, rawUser), 3000);
+ * setTimeout(() => {
+ *   console.log('final proxied', userProxy)
+ *   console.log('final unproxied', rawUser)
+ * }, 3000);
  * ```
  */
 export declare function unproxy<T>(target: T): T;
@@ -428,7 +431,7 @@ export declare function insertCss(style: object, global?: boolean): string;
  *
  *   try {
  *     // Attempt to show a custom message in the UI
- *     $('div.error-display:Oops, something went wrong!');
+ *     $('div.error-message:Oops, something went wrong!');
  *   } catch (e) {
  *     // Ignore errors during error handling itself
  *   }
@@ -436,8 +439,20 @@ export declare function insertCss(style: object, global?: boolean): string;
  *   return false; // Suppress default console log and DOM error message
  * });
  *
+ * // Styling for our custom error message
+ * insertCss({
+ *   '.error-message': {
+ *     backgroundColor: '#e31f00',
+ *     display: 'inline-block',
+ *     color: 'white',
+ *     borderRadius: '3px',
+ *     padding: '2px 4px',
+ *   }
+ * }, true); // global style
+ *
  * // Cause an error within a render scope.
  * $('div.box', () => {
+ *   // Will cause our error handler to insert an error message within the box
  *   noSuchFunction();
  * })
  * ```