@webqit/observer 3.8.12 → 3.8.14

package/README.md

@@ -15,26 +15,26 @@ Observe and intercept operations on arbitrary JavaScript objects and arrays usin
 
 This API re-explores the unique design of the retired [Object.observe()](https://web.dev/es7-observe/) API and unifies that with the rest of JavaScript's metaprogramming APIs: `Proxies`, `Reflect`, `Object`!
 
-The Observer API comes as one little API for all things _object observability_. (Only `~5.8KiB min|zip`)
+Observer comes as one little API for all things _object observability_. (Only `~5.8KiB min|zip`)
 
 ```js
-const state = {};
+const obj = {};
 
 // Observe all property changes
-Observer.observe(state, (mutations) => {
+Observer.observe(obj, (mutations) => {
   mutations.forEach(mutation => {
     console.log(`${mutation.type}: ${mutation.key} = ${mutation.value}`);
   });
 });
 
-Observer.set(state, 'count', 5);
-Observer.deleteProperty(state, 'oldProp');
+Observer.set(obj, 'count', 5);
+Observer.deleteProperty(obj, 'oldProp');
 ```
 
 > [!TIP]
-> Reactivity is anchored on its programmtic APIs like `.set()`, `.deleteProperty()`, but you also get reactivity over literal JavaScript operations like `obj.prop = value`, `delete obj.prop` — by means of the `accessorize()` and `proxy()` methods covered just ahead.
+> Reactivity is anchored on its programmtic APIs like `.set()`, `.deleteProperty()`, but you also get reactivity over literal JavaScript operations — `obj.prop = value`, `delete obj.prop`, etc. — by means of the `accessorize()` and `proxy()` methods covered just ahead.
 >
-> For full-fledged Imperative Reactive Programming, you may want to see the [Quantum JS](https://github.com/webqit/quantum-js) project.
+> For full-fledged Imperative Reactive Programming, you want to see the [Quantum JS](https://github.com/webqit/quantum-js) project.
 
 ---
 
@@ -88,16 +88,18 @@ This limitation in the language has long created a **blindspot** — and a **wea
   state = { ...state, items: [...state.items, 'new item 3'] };
   ```
 
-  > Because this is generally hard to follow, frameworks typically enforce immutability using strong design constraints. Outside of a framework, you get standalone *immutability* libraries (like Immer, or Immutable.js back in the day) that as well try to simulate an immutable world, where data is never changed, only replaced.
+  > Because this is generally hard to follow, frameworks typically enforce immutability by means of strong design constraints. 
+  >
+  > Outside of a framework, you get standalone *immutability* libraries (like Immer, or Immutable.js back in the day) that as well try to simulate an immutable world, where data is never changed, only replaced.
 
 + mutation gets a bad rap
 
 **Using the Observer API:**
 
-By enabling observability at the object/array level, the Observer API effectively solves reactivity for a mutable world. **The Result** is *mutation-based reactivity* as a first-class concept in JavaScript. Consequently:
+By enabling observability at the object/array level, the Observer API effectively solves reactivity for a **mutable** world. The Result is *mutation-based* reactivity as a first-class concept in JavaScript. Consequently:
 
-+ you are able to weild *the sheer power of mutability* in programming to your advantage
-+ you are able to make sense of a mutable world — and integrate with it — rather than stand at odds with it
++ you are able to weild *the full power* of mutability in programming to your advantage
++ you are able to make sense of a mutable world — and integrate with it — rather than struggle with it
 
 ## Quick Start
 
@@ -157,7 +159,8 @@ Observer.set(items, 0, 'grape');
 Observer.set(items, 2, 'orange');
 
 // Reactive method calls
-Observer.apply(items.push, items, ['new item']); // Observer.proxy(state.items).push('new item')
+Observer.apply(items.push, items, ['new item']);
+Observer.proxy(state.items).push('new item')
 ```
 
 ### Intercepting Operations
@@ -324,7 +327,7 @@ parentController.abort();
 #### Parity Table
 
 | | Observer API | Object.observe() (Deprecated) |
-|-------------|--------------|-------------------------------|
+|:-------------|:--------------|:-------------------------------|
 | **Signature** | `.observe(target, callback, options?)` | `.observe(target, callback, acceptList?)` |
 | **Return Value** | `AbortController` (lifecycle management) | `undefined` (no lifecycle management) |
 | **Additional Features** | AbortSignal integration, path watching, batch/atomic operations, synchronous event model, etc. | Basic object observation, asynchronous event model (deprecated) |
@@ -424,7 +427,7 @@ Observer.intercept(obj, 'get', (operation, previous, next) => {
 #### Parity Table
 
 | | Observer API | Proxy Traps |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.intercept(target, operation, handler, options?)`<br>`.intercept(target, { [operation]: handler[, ...]}, options?)` | `new Proxy(target, { [operation]: handler[, ...] })` |
 | **Return Value** | `undefined` (registration) | `Proxy` (wrapped object) |
 | **Additional Features** | Traps pipeline, composable interceptors | Single trap per operation, no composability |
@@ -475,7 +478,7 @@ Observer.set(obj, Observer.path('user', 'profile', 'name'), 'Alice');
 #### Parity Table
 
 | | Observer API | Reflect API |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.set(target, key, value, options?)` | `.set(target, key, value)` |
 | **Return Value** | `boolean` (success) | `boolean` (success) |
 | **Additional Features** | Triggers observers, interceptable | Standard property setting |
@@ -509,7 +512,7 @@ Observer.get(obj, 'fullName'); // "John Doe" (computed on-the-fly)
 #### Parity Table
 
 | | Observer API | Reflect API |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.get(target, key, options?)` | `.get(target, key)` |
 | **Return Value** | `any` (property value) | `any` (property value) |
 | **Additional Features** | Interceptable for computed values | Standard property access |
@@ -543,7 +546,7 @@ Observer.has(obj, 'password'); // false (hidden from checks)
 #### Parity Table
 
 | | Observer API | Reflect API |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.has(target, key, options?)` | `.has(target, key)` |
 | **Return Value** | `boolean` (exists) | `boolean` (exists) |
 | **Additional Features** | Interceptable for property hiding | Standard property existence check |
@@ -574,7 +577,7 @@ Observer.ownKeys(obj); // ['name', 'email'] (password filtered out)
 #### Parity Table
 
 | | Observer API | Reflect API | Object API |
-|-------------|--------------|-------------|-------------|
+|:-------------|:--------------|:-------------|:-------------|
 | **Signature** | `.ownKeys(target, options?)` | `.ownKeys(target)` | `.keys(obj)` |
 | **Return Value** | `string[]` (keys) | `string[]` (keys) | `string[]` (keys) |
 | **Additional Features** | Interceptable for key filtering | Standard key enumeration | Standard key enumeration |
@@ -592,7 +595,7 @@ Observer.deleteProperty(arr, 0);
 #### Parity Table
 
 | | Observer API | Reflect API |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.deleteProperty(target, key, options?)` | `.deleteProperty(target, key)` |
 | **Return Value** | `boolean` (success) | `boolean` (success) |
 | **Additional Features** | Triggers observers, interceptable | Standard property deletion |
@@ -608,7 +611,7 @@ Observer.deleteProperties(obj, ['oldProp1', 'oldProp2', 'tempProp']);
 #### Parity Table
 
 | | Observer API | No Direct Equivalent |
-|-------------|--------------|---------------------|
+|:-------------|:--------------|:---------------------|
 | **Signature** | `.deleteProperties(target, keys, options?)` | No batch delete in standard APIs |
 | **Return Value** | `boolean[]` (success array) | N/A |
 | **Additional Features** | Triggers observers, interceptable | N/A |
@@ -628,7 +631,7 @@ Observer.defineProperty(obj, 'computed', {
 #### Parity Table
 
 | | Observer API | Reflect API | Object API |
-|-------------|--------------|-------------|-------------|
+|:-------------|:--------------|:-------------|:-------------|
 | **Signature** | `.defineProperty(target, key, descriptor, options?)` | `.defineProperty(target, key, descriptor)` | `.defineProperty(obj, key, descriptor)` |
 | **Return Value** | `boolean` (success) | `boolean` (success) | `object` (modified object) |
 | **Additional Features** | Triggers observers, interceptable | Standard property definition | Standard property definition |
@@ -648,7 +651,7 @@ Observer.defineProperties(obj, {
 #### Parity Table
 
 | | Observer API | Object API |
-|-------------|--------------|-------------|
+|:-------------|:--------------|:-------------|
 | **Signature** | `.defineProperties(target, descriptors, options?)` | `.defineProperties(obj, descriptors)` |
 | **Return Value** | `boolean` (success) | `object` (modified object) |
 | **Additional Features** | Triggers observers, interceptable | Standard property definition |
@@ -676,7 +679,7 @@ obj.email = 'alice@example.com';
 #### Parity Table
 
 | | Observer API | No Direct Equivalent |
-|-------------|--------------|---------------------|
+|:-------------|:--------------|:---------------------|
 | **Signature** | `.accessorize(target, properties?, options?)` | No direct equivalent in standard APIs |
 | **Return Value** | `undefined` (modification) | N/A |
 | **Additional Features** | Makes properties reactive for direct assignment | N/A |
@@ -696,7 +699,7 @@ Observer.unaccessorize(obj);
 #### Parity Table
 
 | | Observer API | No Direct Equivalent |
-|-------------|--------------|---------------------|
+|:-------------|:--------------|:---------------------|
 | **Signature** | `.unaccessorize(target, properties?, options?)` | No direct equivalent in standard APIs |
 | **Return Value** | `undefined` (modification) | N/A |
 | **Additional Features** | Restores accessorized properties to normal state | N/A |
@@ -866,7 +869,7 @@ const $obj = Observer.proxy(obj, {}, (traps) => {
 #### Parity Table
 
 | | Observer API | Proxy API |
-|-------------|--------------|-----------|
+|:-------------|:--------------|:-----------|
 | **Signature** | `.proxy(target, options?)` | `new Proxy(target, handlers)` |
 | **Return Value** | `Proxy` (reactive proxy) | `Proxy` (standard proxy) |
 | **Additional Features** | Built-in reactivity, membrane, chainable | Manual trap implementation required |
@@ -883,7 +886,7 @@ const original = Observer.unproxy($obj); // Returns original obj
 #### Parity Table
 
 | | Observer API | No Direct Equivalent |
-|-------------|--------------|---------------------|
+|:-------------|:--------------|:---------------------|
 | **Signature** | `.unproxy(target)` | No direct equivalent in standard APIs |
 | **Return Value** | `object` (original object) | N/A |
 | **Additional Features** | Extracts original object from Observer proxy | N/A |

package/package.json

@@ -12,7 +12,7 @@
     "events"
   ],
   "homepage": "https://webqit.io/tooling/observer",
-  "version": "3.8.12",
+  "version": "3.8.14",
   "license": "MIT",
   "repository": {
     "type": "git",