@geodaoyu/accessor 1.0.1 → 2.0.0

package/README.md

@@ -1,282 +1,361 @@
-# Accessor
-
-Class: `Accessor`
-
-Accessor is an abstract class that facilitates the access to instance properties as well as a mechanism to watch for property changes. Every sub-class of Accessor defines properties that are directly accessible or by using the **get()** and **set()** methods. It is possible to watch for a property changes by using the **watch()** method.
-
-## Installation
-
-``` shell
-npm install @geodaoyu/accessor
-```
-
-## Property Overview
-
-| Name          | Type                                                         | Summary                | Class    |
-| ------------- | ------------------------------------------------------------ | ---------------------- | -------- |
-| declaredClass | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The name of the class. | Accessor |
-
-### Property Details
-
-<table><tr><td bgcolor=#ddd><b>declaredClass</b> <span>String</span> <span>readonly</span></td></tr></table>
-
-The name of the class.
-
-## Method Overview
-
-| Name    | Return Type | Summary                                       | Class    |
-| ------- | ----------- | --------------------------------------------- | -------- |
-| get()   | *           | Gets the value of a property.                 | Accessor |
-| set()   | *           | Sets the value of a property.                 | Accessor |
-| watch() | WatchHandle | Watches for property changes on the instance. | Accessor |
-
-### Method Details
-
-<table><tr><td bgcolor=#ddd><b>get(path){*}</b></td></tr></table>
-
-Gets the value of a property.
-
-The name of the property can refer to a property in the instance. 
-
-```javascript
-view.get("scale"); 
-```
-
-It can also be a path to a property deeper in the instance. `get()` returns `undefined` if a property in the path doesn't exist.
-
-```javascript
-var title = map.get("basemap.title");
-
-// equivalent of
-var title = map.basemap && map.basemap.title || undefined;
-```
-
-Parameter:
-
-| **path**                         | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |
-| -------------------------------- | ------------------------------------------------------------ |
-| The path of the property to get. |                                                              |
-
-Returns:
-
-| Type | Description           |
-| ---- | --------------------- |
-| *    | The property's value. |
-
-<table><tr><td bgcolor=#ddd><b>set(path, value){*}</b></td></tr></table>
-
-Sets the value of a property.
-
-Call `set()` with a property name and a value to change the value of the property.
-
-``` javascript
-// setting the basemap of the map
-map.set("basemap", "topo-vector");
-// is equivalent to
-map.basemap = "topo-vector";
-
-// currying set
-var updateViewScale = view.set.bind(view, "scale");
-updateViewScale(5000);
-```
-
-`set()` can be called with the path to a property and a value. The property is not set if a property in the path doesn't exist.
-
-``` javascript
-// updating the title of the basemap
-map.set("basemap.title", "World Topographic Map");
-
-// is equivalent to
-if (map.basemap != null) {
-  map.basemap.title = "World Topographic Map";
-}
-```
-
-An object with key-value pairs may be passed into `set()` to update multiple properties at once.
-
-```javascript
-// setting a viewpoint on the view
-view.set({
-  center: [-4.4861, 48.3904],
-  scale: 5000
-});
-
-// currying set
-var updateView = view.set.bind(view);
-
-updateView({
-  center: [-4.4861, 48.3904],
-  scale: 5000
-});
-```
-
- Parameters:
-
-| **path**                                                     | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) |
-| ------------------------------------------------------------ | ------------------------------------------------------------ |
-| The path to the property to set, or an object of key-value pairs. |                                                              |
-| **value**                                                    | *                                                            |
-| *The new value to set on the property.                       |                                                              |
-
-Returns:
-
-| Type | Description   |
-| ---- | ------------- |
-| *    | The instance. |
-
-<table><tr><td bgcolor=#ddd><b>watch(path, callback){WatchHandle}</b></td></tr></table>
-
-Watches for property changes on the instance.
-
-Watching for property changes is essential for tracking changes on objects. To start watching for changes on a property, call `watch()` with the property name and a callback function that will execute each time the property changes.
-
-``` javascript
-var handle = mapview.watch("scale", function(newValue, oldValue, propertyName, target) {
-  console.log(propertyName + " changed from " + oldValue + " to " + newValue);
-})
-```
-
-To stop watching for changes, call the `remove()` method on the object that `watch()` returns.
-
-``` javascript
-handle.remove();
-```
-
-It is important to store the resulting objects from `watch()` to properly clean up the references.
-
-```javascript
-var viewHandles = [];
-function setView(view) {
-  // remove the handles for the current view.
-  viewHandles.forEach(function(handle) {
-    handle.remove();
-  });
-  viewHandles.length = 0;
-
-  this.view = view;
-
-  // watch for properties on the newly set view.
-  if (view) {
-    viewHandles.push(
-      view.watch("scale", scaleWatcher);
-    );
-  }
-}
-
-setView(mapView);
-setView(null);
-```
-
-Like `get()` and `set()`, it is possible to watch for a property deep in the object hierarchy by passing a path. If a property in the path doesn't exist the watch callback is called with `undefined`.
-
-``` javascript
-var view = new SceneView({
-  map: new Map({
-    basemap: "streets-vector"
-  })
-});
-
-view.watch("map.basemap.title", function(newValue, oldValue) {
-  console.log("basemap's title changed from " + oldValue + " to " + newValue);
-});
-
-view.map.basemap = "topo-vector";
-// output: "basemap's title changed from Streets to Topographic"
-
-view.map = null;
-// output: "basemap's title changed from Topographic to undefined"
-```
-
-Pass a comma delimited list of property paths, or an array of property paths, to watch multiple properties with the same callback. Use the third parameter of the callback call to determine what property changed.
-
-``` javascript
-view.watch("center, scale, rotation", function(newValue, oldValue, propertyName) {
-  console.log(propertyName + " changed");
-});
-
-// equivalent of
-view.watch(["center", "scale", "rotation"], function(newValue, oldValue, propertyName) {
-  console.log(propertyName + " changed");
-});
-
-// equivalent of
-var callback = function(newValue, oldValue, propertyName) {
-  console.log(propertyName + " changed");
-}
-view.watch("center", callback);
-view.watch("scale", callback);
-view.watch("rotation", callback);
-```
-
-`Accessor` doesn't call the watch callbacks for a property immediately after its value changes. Instead, when a property's value changes and if that property is watched, `Accessor` schedules a notification which is then processed at a later time. Properties that change frequently like `view.scale` can be watched without having to throttle the callback.
-
-``` javascript
-// Divides the view.scale three times
-view.watch("scale", function(newValue, oldValue) {
-  console.log("view's scale changed from " + oldValue + " to " + newValue);
-});
-console.log("current view scale: " + view.scale);
-view.scale = view.scale / 2;
-view.scale = view.scale / 2;
-view.scale = view.scale / 2;
-console.log("current view scale: " + view.scale);
-
-// output the following:
-// current view scale: 36978595.474472
-// current view scale: 4622324.434309
-// view's scale changed from 36978595.474472 to 4622324.434309
-```
-
-Parameters:
-
-| **path**                                                     | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| String[] |
-| ------------------------------------------------------------ | ------------------------------------------------------------ |
-| The property or properties to watch. Multiple properties can be specified as a comma-separated list. |                                                              |
-| **callback**                                                 | watchCallback                                                |
-| The callback to execute when the property value has changed. |                                                              |
-
-Returns:
-
-| Type        | Description    |
-| ----------- | -------------- |
-| WatchHandle | A watch handle |
-
-## Type Definitions
-
-<table><tr><td bgcolor=#ddd><b>watchCallback(newValue, oldValue, propertyName, target)</b></td></tr></table>
-
-Callback to be called when a watched property changes.
-
-Parameters:
-
-| **newValue**                                      | *                                                            |
-| ------------------------------------------------- | ------------------------------------------------------------ |
-| The new value of the watched property.            |                                                              |
-| **oldValue**                                      | *                                                            |
-| The old value of the watched property.            |                                                              |
-| **propertyName**                                  | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) |
-| The property name.                                |                                                              |
-| **target**                                        | Accessor                                                     |
-| The object containing the property being watched. |                                                              |
-
-<table><tr><td bgcolor=#ddd><b>WatchHandle</b> <span>Object</span></td></tr></table>
-
-Represents a watch created when an object invokes **watch()**.
-
-Property:
-
-| **remove**                | [Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) |
-| ------------------------- | ------------------------------------------------------------ |
-| Removes the watch handle. |                                                              |
-
-Example:
-
-``` javascript
-var handle = map.watch('basemap', function(newVal){
-  // Each time the value of map.basemap changes, it is logged in the console
-  console.log("new basemap: ", newVal);
-});
-
-// When remove() is called on the watch handle, the map no longer watches for changes to basemap
-handle.remove();
-```
+# Accessor
+
+## Overview
+
+Accessor is an abstract class that facilitates the access to instance properties as well as a mechanism to watch for property changes. Every sub-class of Accessor defines properties that are directly accessible or by using the **get()** and **set()** methods. It is possible to watch for a property changes by using the **watch()** method.
+
+## Property Overview
+
+| Name          | Type                                                         | Summary                | Class    |
+| ------------- | ------------------------------------------------------------ | ---------------------- | -------- |
+| declaredClass | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | The name of the class. | Accessor |
+
+### Property Details
+
+<table><tr><td bgcolor=#ddd><b>declaredClass</b> <span>String</span> <span>readonly</span></td></tr></table>
+
+The name of the class.
+
+## Method Overview
+
+| Name  | Return Type | Summary                       | Class    |
+| ----- | ----------- | ----------------------------- | -------- |
+| set() | *           | Sets the value of a property. | Accessor |
+
+### Method Details
+
+<table><tr><td bgcolor=#ddd><b>set(path, value) {*}</b></td></tr></table>
+
+Sets the value of a property.
+
+Call `set()` with a property name and a value to change the value of the property.
+
+``` javascript
+// setting the basemap of the map
+map.set("basemap", "topo-vector");
+// is equivalent to
+map.basemap = "topo-vector";
+
+// currying set
+const updateViewScale = view.set.bind(view, "scale");
+updateViewScale(5000);
+```
+
+`set()` can be called with the path to a property and a value. The property is not set if a property in the path doesn't exist.
+
+``` javascript
+// updating the title of the basemap
+map.set("basemap.title", "World Topographic Map");
+
+// is equivalent to
+if (map.basemap != null) {
+  map.basemap.title = "World Topographic Map";
+}
+```
+
+An object with key-value pairs may be passed into `set()` to update multiple properties at once.
+
+```javascript
+// setting a viewpoint on the view
+view.set({
+  center: [-4.4861, 48.3904],
+  scale: 5000
+});
+
+// currying set
+const updateView = view.set.bind(view);
+
+updateView({
+  center: [-4.4861, 48.3904],
+  scale: 5000
+});
+```
+
+ Parameters:
+
+| **path**                                                     | [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| The path to the property to set, or an object of key-value pairs. |                                                              |
+| **value**                                                    | *                                                            |
+| The new value to set on the property.                        |                                                              |
+
+Returns:
+
+| Type | Description   |
+| ---- | ------------- |
+| *    | The instance. |
+
+# reactiveUtils
+
+## Overview
+
+`reactiveUtils` provide capabilities for observing changes to the state of the SDK's properties, and is an important part of managing your application's life-cycle. State can be observed on a variety of different data types and structures including strings, numbers, arrays, booleans, collections, and objects.
+
+## Using reactiveUtils
+
+`reactiveUtils` provides five methods that offer different patterns and capabilities for observing state: [on()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#on), [once()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#once), [watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#watch), [when()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#when) and [whenOnce()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#whenOnce).
+
+The following is a basic example using [reactiveUtils.watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#watch). It demonstrates how to track the Map component [updating](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#updating) property and then send a message to the console when the property changes. This snippet uses a `getValue` function as an expression that evaluates the `updating` property, and when a change is observed the new value is passed to the callback:
+
+```
+// Basic example of watching for changes on a boolean property
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+  // getValue function
+  () => viewElement.updating,
+  // callback
+  (updating) => {
+    console.log(updating)
+  });
+```
+
+
+
+### Working with collections
+
+`reactiveUtils` can be used to observe changes within a collection, such as [Map.allLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#allLayers). Out-of-the-box JavaScript methods such as [`.map()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map) and [`.filter()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) can be used as expressions to be evaluated in the `getValue` function.
+
+```
+// Watching for changes within a collection
+// whenever a new layer is added to the map
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+  () => viewElement.map.allLayers.map( layer => layer.id),
+  (ids) => {
+    console.log(`FeatureLayer IDs ${ids}`);
+  });
+```
+
+
+
+### Working with objects
+
+With `reactiveUtils` you can track named object properties through dot notation (e.g. `viewElement.updating`) or through bracket notation (e.g. `viewElement["updating"]`). You can also use the [optional chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining) operator (`?.`). This operator simplifies the process of verifying that properties used in the `getValue` function are not `undefined` or `null`.
+
+```
+// Watch for changes in an object using optional chaining
+// whenever the map's extent changes
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+  () => viewElement?.extent?.xmin,
+  (xmin) => {
+    console.log(`Extent change xmin = ${xmin}`)
+  });
+```
+
+
+
+### WatchHandles and Promises
+
+The [watch()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#watch), [on()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#on) and [when()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#when) methods return a [WatchHandle](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Accessor.html#WatchHandle). Be sure to remove watch handles when they are no longer needed to avoid memory leaks.
+
+```
+// Use a WatchHandle to stop watching
+const viewElement = document.querySelector("arcgis-map");
+const handle = reactiveUtils.watch(
+  () => viewElement?.extent?.xmin,
+  (xmin) => {
+    console.log(`Extent change xmin = ${xmin}`)
+  });
+
+// In another function
+handle.remove()
+```
+
+The [once()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#once) and [whenOnce()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#whenOnce) methods return a Promise instead of a `WatchHandle`. In some advanced use cases where an API action may take additional time, these methods also offer the option to cancel the async callback via an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/signal). Be aware that if the returned Promise is not resolved, it can also result in a memory leak.
+
+```
+// Use an AbortSignal to cancel an async callback
+// during view animation
+const abortController = new AbortController();
+
+// Observe the View's animation state
+reactiveUtils.whenOnce(
+  () => view?.animation, {signal: abortController.signal})
+  .then((animation) => {
+    console.log(`View animation state is ${animation.state}`)
+  });
+
+// Cancel the async callback
+const someFunction = () => {
+  abortController.abort();
+}
+```
+
+
+
+### Working with truthy values
+
+The [when()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#when) and [whenOnce()](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-reactiveUtils.html#whenOnce) methods watch for *truthy* values, these are values that evaluate to `true` in boolean contexts. To learn more about using truthy, visit this [MDN Web doc](https://developer.mozilla.org/en-US/docs/Glossary/Truthy) article. The snippets below use the [Popup.visible](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) property, which is a boolean.
+
+```
+// Observe changes on a boolean property
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.when(() => viewElement.popup?.visible, () => console.log("Truthy"));
+reactiveUtils.when(() => !viewElement.popup?.visible, () => console.log("Not truthy"));
+reactiveUtils.when(() => viewElement.popup?.visible === true, () => console.log("True"));
+reactiveUtils.when(() => viewElement.popup?.visible !== undefined, () => console.log("Defined"));
+reactiveUtils.when(() => viewElement.popup?.visible === undefined, () => console.log("Undefined"));
+```
+
+## Method Overview
+
+| Name    | Return Type | Summary                                                      | Object        |
+| ------- | ----------- | ------------------------------------------------------------ | ------------- |
+| watch() | WatchHandle | Tracks any properties accessed in the `getValue` function and calls the callback when any of them change. | reactiveUtils |
+
+### Method Details
+<table><tr><td bgcolor=#ddd><b>watch(getValue, callback, options?){WatchHandle}</b></td></tr></table>
+
+Tracks any properties accessed in the `getValue` function and calls the callback when any of them change.
+
+Parameters:
+
+| **getValue**                                                 | ReactiveWatchExpression   |
+| ------------------------------------------------------------ | ------------------------- |
+| Function used to get the current value. All accessed properties will be tracked. |                           |
+| **callback**                                                 | **ReactiveWatchCallback** |
+| The function to call when there are changes.                 |                           |
+| **options**                                                  | **ReactiveWatchOptions**  |
+| Options used to configure how the tracking happens and how the callback is to be called. |                           |
+
+Returns:
+
+| Type        | Description    |
+| ----------- | -------------- |
+| WatchHandle | A watch handle |
+
+Examples
+
+```js
+// Watching for changes in a boolean value
+// Equivalent to watchUtils.watch()
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+ () => viewElement.popup?.visible,
+ () => {
+   console.log(`Popup visible: ${viewElement.popup.visible}`);
+ });
+// Watching for changes within a Collection
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+ () => viewElement.map.allLayers.length,
+ () => {
+   console.log(`Layer collection length changed: ${viewElement.map.allLayers.length}`);
+ });
+// Watch for changes in a numerical value.
+// Providing `initial: true` in ReactiveWatchOptions
+// checks immediately after initialization
+// Equivalent to watchUtils.init()
+const viewElement = document.querySelector("arcgis-map");
+reactiveUtils.watch(
+ () => viewElement.zoom,
+ () => {
+   console.log(`zoom changed to ${viewElement.zoom}`);
+ },
+ {
+   initial: true
+ });
+// Watch properties from multiple sources
+const viewElement = document.querySelector("arcgis-map");
+const handle = reactiveUtils.watch(
+ () => [viewElement.stationary, viewElement.zoom],
+ ([stationary, zoom]) => {
+   // Only print the new zoom value when the map component is stationary
+   if(stationary){
+     console.log(`Change in zoom level: ${zoom}`);
+   }
+ }
+);
+```
+
+## Type Definitions
+
+<table><tr><td bgcolor=#ddd><b>WatchHandle</b> <span>Object</span></td></tr></table>
+
+Represents a watch or event handler which can be removed.
+
+Property:
+
+| **remove**                | [Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) |
+| ------------------------- | ------------------------------------------------------------ |
+| Removes the watch handle. |                                                              |
+
+Example:
+
+``` javascript
+const handle = reactiveUtils.watch(() => map.basemap, (newVal) => {
+  // Each time the value of map.basemap changes, it is logged in the console
+  console.log("new basemap: ", newVal);
+});
+
+// When remove() is called on the watch handle, the map no longer watches for changes to basemap
+handle.remove();
+```
+
+<table><tr><td bgcolor=#ddd><b>ReactiveEqualityFunction(newValue, oldValue) {Boolean}</b></td></tr></table>
+
+Function used to check whether two values are the same, in which case the watch callback isn't called.
+
+Parameters:
+
+| **newValue**   | *    |
+| -------------- | ---- |
+| The new value. |      |
+| **oldValue**   | *    |
+| The old value. |      |
+
+Returns:
+
+| Type    | Description                                      |
+| ------- | ------------------------------------------------ |
+| Boolean | Whether the new value is equal to the old value. |
+
+<table><tr><td bgcolor=#ddd><b>ReactiveListenerChangeCallback(target?)</b></td></tr></table>
+
+Function used to check whether two values are the same, in which case the watch callback isn't called.
+
+Parameters:
+
+| **target**                                                   | *    |
+| ------------------------------------------------------------ | ---- |
+| The event target to which the listener was added or from which it was removed. |      |
+
+<table><tr><td bgcolor=#ddd><b>ReactiveWatchCallback(newValue, oldValue) {Boolean}</b></td></tr></table>
+
+Function to be called when a value changes.
+
+Parameters:
+
+| **newValue**   | *    |
+| -------------- | ---- |
+| The new value. |      |
+| **oldValue**   | *    |
+| The old value. |      |
+
+<table><tr><td bgcolor=#ddd><b>ReactiveWatchExpression(){*}</b></td></tr></table>
+
+Function which is auto-tracked and should return a value to pass to the ReactiveWatchCallback
+
+Returns:
+
+| Type | Description    |
+| ---- | -------------- |
+| *    | The new value. |
+
+<table><tr><td bgcolor=#ddd><b>ReactiveWatchOptions</b> <span>Object</span></td></tr></table>
+
+Options used to configure how auto-tracking is performed and how the callback should be called.
+
+Property:
+
+| **initial**                                                  | Boolean                      |
+| ------------------------------------------------------------ | ---------------------------- |
+| Default Value:false<br />Whether to fire the callback immediately after initialization, if the necessary conditions are met. |                              |
+| **sync**                                                     | **Boolean**                  |
+| Default Value:false<br />Whether to fire the callback synchronously or on the next tick. |                              |
+| **once**                                                     | **Boolean**                  |
+| Default Value:false<br />Whether to fire the callback only once. |                              |
+| **equals**                                                   | **ReactiveEqualityFunction** |
+| Function used to check whether two values are the same, in which case the callback isn't called. Checks whether two objects, arrays or primitive values are shallow equal, e.g. one level deep. Non-plain objects are considered equal if they are strictly equal (===). |                              |
+

package/package.json

@@ -1,27 +1,28 @@
-{
-  "name": "@geodaoyu/accessor",
-  "version": "1.0.1",
-  "description": "Implement esri/core/Accessor by myself.",
-  "main": "index.js",
-  "module": "dist/index.js",
-  "scripts": {
-    "build": "npx tsc",
-    "test": "mocha"
-  },
-  "keywords": [
-    "Accessor",
-    "Esri",
-    "ArcGIS"
-  ],
-  "author": "GeoDaoyu",
-  "license": "MIT",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/GeoDaoyu/Accessor.git"
-  },
-  "devDependencies": {
-    "mocha": "^8.3.2",
-    "typescript": "^4.2.4"
-  }
-}
+{
+  "name": "@geodaoyu/accessor",
+  "version": "2.0.0",
+  "description": "mini @arcgis/core/core/Accessor & @arcgis/core/core/reactiveUtils",
+  "main": "index.js",
+  "module": "dist/index.js",
+  "scripts": {
+    "build": "npx tsc",
+    "test": "mocha"
+  },
+  "keywords": [
+    "Accessor",
+    "Esri",
+    "ArcGIS",
+    "Proxy"
+  ],
+  "author": "GeoDaoyu",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GeoDaoyu/Accessor.git"
+  },
+  "devDependencies": {
+    "mocha": "^11.7.1",
+    "typescript": "^5.8.3"
+  }
+}

package/src/accessor.ts

@@ -1,125 +1,119 @@
-type WatchCallback = (
-  newValue: any,
-  oldValue: any,
-  propertyName: string,
-  target: Accessor
-) => void;
-
-interface WatchHandle extends Object {
-  /**
-   * Removes the watch handle.
-   */
-  remove(): void;
-}
-
-interface Handle {
-  path: string;
-  callback: Function;
-}
-
-/**
- * observe class
- * @param cls class
- * @returns Proxy
- */
-function observe(cls) {
-  return new Proxy(cls, {
-    construct(target, args) {
-      const obj = new target(...args);
-      return new Proxy(obj, {
-        set: (target, key, value, receiver) => {
-          const oldValue = target[key];
-          target._handles.forEach((handle) => {
-            if (handle.path === key) {
-              handle.callback(value, oldValue, key, target);
-            }
-          });
-          return Reflect.set(target, key, value, receiver);
-        },
-      });
-    },
-  });
-}
-
-class Accessor {
-  declaredClass: string;
-  private _handles: Set<Handle>;
-
-  constructor(props: object) {
-    for (let prop in props) {
-      this[prop] = props[prop];
-    }
-    this.declaredClass = "Accessor";
-    this._handles = new Set();
-  }
-  get(path: string): any {
-    const dotIndex = path.indexOf(".");
-    if (dotIndex !== -1) {
-      const key = path.slice(0, dotIndex);
-      const value = path.slice(dotIndex + 1);
-      return this[key] && this[key].get(value);
-    }
-    return this[path];
-  }
-  set(path: string | object, value: any): this {
-    if (typeof path === "string") {
-      const dotIndex = path.indexOf(".");
-      if (dotIndex !== -1) {
-        const key = path.slice(0, dotIndex);
-        const childPath = path.slice(dotIndex + 1);
-        if (this[key]) {
-          this[key].set(childPath, value);
-        }
-      } else {
-        this[path] = value;
-      }
-    } else {
-      for (const key in path) {
-        this.set(key, path[key]);
-      }
-    }
-
-    return this;
-  }
-  watch(path: string | string[], callback: WatchCallback): WatchHandle {
-    const handles = [];
-    const pathArray = [];
-    if (typeof path === "object") {
-      pathArray.push(...path);
-    }
-    if (typeof path === "string") {
-      if (path.includes(",")) {
-        pathArray.push(...path.replace(" ", "").split(","));
-      } else {
-        pathArray.push(path);
-      }
-    }
-    pathArray.forEach((item) => {
-      let handle;
-      const dotIndex = item.indexOf(".");
-      if (dotIndex !== -1) {
-        const key = item.slice(0, dotIndex);
-        const value = item.slice(dotIndex + 1);
-        handle = this[key].watch(value, callback);
-      } else {
-        handle = {
-          path: item,
-          callback,
-        };
-      }
-      handles.push(handle);
-      this._handles.add(handle);
-    });
-
-    const watchHandle = {
-      remove: () => {
-        handles.forEach((handle) => {
-          this._handles.delete(handle);
-        });
-      },
-    };
-    return watchHandle;
-  }
-}
-
-export default observe(Accessor);
+type WatchCallback = (
+  newValue: any,
+  oldValue: any,
+  propertyName: string,
+  target: Accessor
+) => void;
+
+interface WatchHandle extends Object {
+  /**
+   * Removes the watch handle.
+   */
+  remove(): void;
+}
+
+interface Handle {
+  path: string;
+  callback: Function;
+}
+
+class Accessor {
+  declaredClass: string;
+  private _handles: Set<Handle>;
+
+  constructor(props: object = {}) {
+    // 为当前实例创建一个代理
+    const proxy = new Proxy(this, {
+      set: (target, key, value, receiver) => {
+        if (key !== '_handles' && target._handles) {
+          const oldValue = target[key];
+          target._handles.forEach((handle) => {
+            if (handle.path === key) {
+              handle.callback(value, oldValue, key, target);
+            }
+          });
+        }
+        return Reflect.set(target, key, value, receiver);
+      }
+    });
+
+    // 初始化属性
+    for (let prop in props) {
+      proxy[prop] = props[prop];
+    }
+    proxy.declaredClass = "Accessor";
+    proxy._handles = new Set();
+
+    return proxy;
+  }
+  
+  get(path: string): any {
+    const dotIndex = path.indexOf(".");
+    if (dotIndex !== -1) {
+      const key = path.slice(0, dotIndex);
+      const value = path.slice(dotIndex + 1);
+      return this[key] && this[key].get(value);
+    }
+    return this[path];
+  }
+  
+  set(path: string | object, value: any): this {
+    if (typeof path === "string") {
+      const dotIndex = path.indexOf(".");
+      if (dotIndex !== -1) {
+        const key = path.slice(0, dotIndex);
+        const childPath = path.slice(dotIndex + 1);
+        if (this[key]) {
+          this[key].set(childPath, value);
+        }
+      } else {
+        this[path] = value;
+      }
+    } else {
+      for (const key in path) {
+        this.set(key, path[key]);
+      }
+    }
+
+    return this;
+  }
+  
+  watch(path: string | string[], callback: WatchCallback): WatchHandle {
+    const handles = [];
+    const pathArray = [];
+    if (typeof path === "object") {
+      pathArray.push(...path);
+    }
+    if (typeof path === "string") {
+      if (path.includes(",")) {
+        pathArray.push(...path.replace(" ", "").split(","));
+      } else {
+        pathArray.push(path);
+      }
+    }
+    pathArray.forEach((item) => {
+      const dotIndex = item.indexOf(".");
+      const handle =
+        dotIndex !== -1
+          ? this[item.slice(0, dotIndex)].watch(
+              item.slice(dotIndex + 1),
+              callback
+            )
+          : { path: item, callback };
+
+      handles.push(handle);
+      this._handles.add(handle);
+    });
+
+    const watchHandle = {
+      remove: () => {
+        handles.forEach((handle) => {
+          this._handles.delete(handle);
+        });
+      },
+    };
+    return watchHandle;
+  }
+}
+
+export default Accessor;

package/src/index.ts

@@ -1,3 +1,3 @@
-import Accessor from './accessor';
+import Accessor from './accessor.js';
 
 export default Accessor;

package/test/watch.test.js

@@ -1,5 +1,14 @@
 import Accessor from "../dist/index.js";
 import assert from "assert";
+class Counter extends Accessor {
+  constructor() {
+    super();
+    this.number = 0;
+  }
+  setNumber = (value) => {
+    this.number = value;
+  };
+}
 
 describe("#watch()", function () {
   it("watch property change", function () {
@@ -119,4 +128,41 @@ describe("#watch()", function () {
     view.zoom = 5;
     assert.deepStrictEqual(result, []);
   });
+  /**
+   * 子类上的方法也可以被监听
+   */
+  it("watch subclass member", function () {
+    const counter = new Counter();
+    const result = [];
+    const callback = (newValue, oldValue, propertyName, target) => {
+      result.push(newValue, oldValue, propertyName, target);
+    };
+    counter.number = 4;
+    counter.watch("number", callback);
+    counter.setNumber(5);
+
+    assert.deepStrictEqual(result, [5, 4, "number", counter]);
+  });
+
+  /**
+   * 子类上的方法 监听变更次数
+   */
+  it("watch subclass member changed times", function () {
+    const counter = new Counter();
+    let times = 0;
+    const callback = () => {
+      times++;
+    };
+    counter.watch("number", callback);
+    counter.number = 1; // +1;
+    counter.number = 1; // +1;
+    counter.set("number", 2); // +1;
+    counter.set("number", 2); // +1;
+    counter.set({ number: 3 }); // +1;
+    counter.set({ number: 3 }); // +1;
+    counter.setNumber(4); // +1;
+    counter.setNumber(4); // +1;
+
+    assert.equal(times, 8);
+  });
 });

package/tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "experimentalDecorators": true,
-    "module": "ESNext",
+    "module": "Node16",
     "target": "ESNext",
     "sourceMap": false,
     "rootDir": "./src",
@@ -9,7 +9,8 @@
     "esModuleInterop": true,
     "declaration": true,
     "skipLibCheck": true,
-    "moduleResolution": "node",
+    "moduleResolution": "node16",
+    "verbatimModuleSyntax": true
   },
   "include": [
     "src/**/*.ts",

package/dist/accessor.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/accessor.js

@@ -1,103 +0,0 @@
-/**
- * observe class
- * @param cls class
- * @returns Proxy
- */
-function observe(cls) {
-    return new Proxy(cls, {
-        construct(target, args) {
-            const obj = new target(...args);
-            return new Proxy(obj, {
-                set: (target, key, value, receiver) => {
-                    const oldValue = target[key];
-                    target._handles.forEach((handle) => {
-                        if (handle.path === key) {
-                            handle.callback(value, oldValue, key, target);
-                        }
-                    });
-                    return Reflect.set(target, key, value, receiver);
-                },
-            });
-        },
-    });
-}
-class Accessor {
-    constructor(props) {
-        for (let prop in props) {
-            this[prop] = props[prop];
-        }
-        this.declaredClass = "Accessor";
-        this._handles = new Set();
-    }
-    get(path) {
-        const dotIndex = path.indexOf(".");
-        if (dotIndex !== -1) {
-            const key = path.slice(0, dotIndex);
-            const value = path.slice(dotIndex + 1);
-            return this[key] && this[key].get(value);
-        }
-        return this[path];
-    }
-    set(path, value) {
-        if (typeof path === "string") {
-            const dotIndex = path.indexOf(".");
-            if (dotIndex !== -1) {
-                const key = path.slice(0, dotIndex);
-                const childPath = path.slice(dotIndex + 1);
-                if (this[key]) {
-                    this[key].set(childPath, value);
-                }
-            }
-            else {
-                this[path] = value;
-            }
-        }
-        else {
-            for (const key in path) {
-                this.set(key, path[key]);
-            }
-        }
-        return this;
-    }
-    watch(path, callback) {
-        const handles = [];
-        const pathArray = [];
-        if (typeof path === "object") {
-            pathArray.push(...path);
-        }
-        if (typeof path === "string") {
-            if (path.includes(",")) {
-                pathArray.push(...path.replace(" ", "").split(","));
-            }
-            else {
-                pathArray.push(path);
-            }
-        }
-        pathArray.forEach((item) => {
-            let handle;
-            const dotIndex = item.indexOf(".");
-            if (dotIndex !== -1) {
-                const key = item.slice(0, dotIndex);
-                const value = item.slice(dotIndex + 1);
-                handle = this[key].watch(value, callback);
-            }
-            else {
-                handle = {
-                    path: item,
-                    callback,
-                };
-            }
-            handles.push(handle);
-            this._handles.add(handle);
-        });
-        const watchHandle = {
-            remove: () => {
-                handles.forEach((handle) => {
-                    this._handles.delete(handle);
-                });
-            },
-        };
-        return watchHandle;
-    }
-}
-export default observe(Accessor);

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-import Accessor from './accessor';
-export default Accessor;

package/dist/index.js

@@ -1,2 +0,0 @@
-import Accessor from './accessor.js';
-export default Accessor;