@geodaoyu/accessor 2.0.0 → 2.0.1

package/dist/accessor.d.ts

@@ -0,0 +1,16 @@
+type WatchCallback = (newValue: any, oldValue: any, propertyName: string, target: Accessor) => void;
+interface WatchHandle extends Object {
+    /**
+     * Removes the watch handle.
+     */
+    remove(): void;
+}
+declare class Accessor {
+    declaredClass: string;
+    private _handles;
+    constructor(props?: object);
+    get(path: string): any;
+    set(path: string | object, value: any): this;
+    watch(path: string | string[], callback: WatchCallback): WatchHandle;
+}
+export default Accessor;

package/dist/accessor.js

@@ -0,0 +1,89 @@
+class Accessor {
+    declaredClass;
+    _handles;
+    constructor(props = {}) {
+        // 为当前实例创建一个代理
+        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) {
+        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) => {
+            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/dist/index.d.ts

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

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geodaoyu/accessor",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "mini @arcgis/core/core/Accessor & @arcgis/core/core/reactiveUtils",
   "main": "index.js",
   "module": "dist/index.js",
@@ -17,6 +17,12 @@
   "author": "GeoDaoyu",
   "license": "MIT",
   "type": "module",
+  "files": [
+    "dist/**/*",
+    "src/**/*",
+    "README.md",
+    "LICENSE"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/GeoDaoyu/Accessor.git"

package/test/construct.test.js

@@ -1,31 +0,0 @@
-import Accessor from '../dist/index.js';
-import assert from 'assert';
-
-describe('#constructor()', function() {
-  it('typeof accessor should be "object"', function() {
-    const accessor = new Accessor();
-    assert.strictEqual(typeof accessor, 'object');
-  });
-  /**
-   * 可以通过 对象的形式给类 赋初值
-   */
-  it('accessor\'s props can be an object', function() {
-    const view = new Accessor({
-      zoom: 4,
-    });
-    assert.strictEqual(view.zoom, 4);
-  });
-  /**
-   * 子类可以继承Accessor
-   */
-  it('subclass can extend from Accessor', function() {
-    class View extends Accessor {
-      constructor() {
-        super();
-        this.declaredClass = "View";
-      }
-    }
-    const view = new View();
-    assert.strictEqual(view instanceof Accessor, true);
-  });
-});

package/test/get.test.js

@@ -1,34 +0,0 @@
-import Accessor from '../dist/index.js';
-import assert from 'assert';
-
-describe('#get()', function() {
-  /**
-   * 属性不存在,返回undefined
-   */
-  it('should return undefined when the property in the path does not exist', function() {
-    const accessor = new Accessor();
-    assert.strictEqual(accessor.get('map'), undefined);
-  });
-  /**
-   * 设值取值
-   */
-  it('should return 4 when the property is set to 4', function() {
-    const view = new Accessor();
-    view.set('zoom', 4);
-    assert.strictEqual(view.get('zoom'), 4);
-  });
-  it('deep path:should return undefined when the property in the path does not exist', function() {
-    const view = new Accessor();
-    assert.strictEqual(view.get('map.basemap'), undefined);
-  });
-  /**
-   * 获取属性的属性
-   */
-  it('should return the property in the deep path', function() {
-    const map = new Accessor();
-    const basemap = new Accessor();
-    map.set('basemap', basemap);
-    basemap.set('title', 'World Topographic Map');
-    assert.strictEqual(map.get('basemap.title'), 'World Topographic Map');
-  });
-});

package/test/set.test.js

@@ -1,56 +0,0 @@
-import Accessor from "../dist/index.js";
-import assert from "assert";
-
-describe("#set()", function () {
-  it("should return 4 when the property is set to 4", function () {
-    const view = new Accessor();
-    view.set("zoom", 4);
-    assert.strictEqual(view.get("zoom"), 4);
-  });
-  it("should return 4 when the property is 4", function () {
-    const view = new Accessor();
-    view.zoom = 4;
-    assert.strictEqual(view.zoom, 4);
-  });
-  /**
-   * 设置属性的属性
-   */
-  it("deep path set property", function () {
-    const map = new Accessor();
-    const basemap = new Accessor();
-    map.set("basemap", basemap);
-    map.set("basemap.title", "World Topographic Map");
-    assert.strictEqual(map.get("basemap.title"), "World Topographic Map");
-  });
-  /**
-   * 设置属性的属性,当属性不存在的时候,不设置
-   */
-  it("deep path set property which does not exist", function () {
-    const map = new Accessor();
-    map.set("basemap.title", "World Topographic Map");
-    assert.strictEqual(map.get("basemap.title"), undefined);
-  });
-  /**
-   * 可以通过对象的形式批量设置属性
-   */
-  it("An object with key-value pairs can be passed into", function () {
-    const view = new Accessor();
-    view.set({
-      center: [-4.4861, 48.3904],
-      scale: 5000,
-    });
-    assert.strictEqual(view.get("scale"), 5000);
-  });
-  /**
-   * 柯里化
-   */
-  it("An object with key-value pairs can be passed into", function () {
-    const view = new Accessor();
-    const updateView = view.set.bind(view);
-    updateView({
-      center: [-4.4861, 48.3904],
-      scale: 5000,
-    });
-    assert.strictEqual(view.get("scale"), 5000);
-  });
-});

package/test/watch.test.js

@@ -1,168 +0,0 @@
-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 () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor();
-    view.zoom = 4;
-    view.watch("zoom", callback);
-    view.zoom = 5;
-    assert.deepStrictEqual(result, [5, 4, "zoom", view]);
-  });
-  /**
-   * 深层属性的变更的监听
-   * 注意,此时callback的target是指向 拥有这个属性的类,而不是最外层的类
-   */
-  it("watch deep path property change", function () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor({
-      map: new Accessor({
-        basemap: new Accessor({
-          title: "streets-vector",
-        }),
-      }),
-    });
-    view.watch("map.basemap.title", callback);
-    view.map.basemap.title = "topo-vector";
-    assert.deepStrictEqual(result, [
-      "topo-vector",
-      "streets-vector",
-      "title",
-      view.map.basemap,
-    ]);
-  });
-  /**
-   * 一个callback监听多个属性, 字符串形式
-   */
-  it("watch multiple propertys change in string", function () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor({
-      zoom: 12,
-      scale: 144447.638572,
-    });
-    view.watch("zoom, scale", callback);
-    view.zoom = 11;
-    view.scale = 288895.277144;
-    assert.deepStrictEqual(result, [
-      11,
-      12,
-      "zoom",
-      view,
-      288895.277144,
-      144447.638572,
-      "scale",
-      view,
-    ]);
-  });
-  /**
-   * 一个callback监听多个属性, 数组形式
-   */
-  it("watch multiple propertys change in string array", function () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor({
-      zoom: 12,
-      scale: 144447.638572,
-    });
-    view.watch(["zoom", "scale"], callback);
-    view.zoom = 11;
-    view.scale = 288895.277144;
-    assert.deepStrictEqual(result, [
-      11,
-      12,
-      "zoom",
-      view,
-      288895.277144,
-      144447.638572,
-      "scale",
-      view,
-    ]);
-  });
-  /**
-   * 调用remove方法移除handle,callback将不执行
-   */
-  it("remove watch handle", function () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor();
-    view.zoom = 4;
-    const handle = view.watch("zoom", callback);
-    handle.remove();
-    view.zoom = 5;
-    assert.deepStrictEqual(result, []);
-  });
-  /**
-   * 只在注册的属性变更后执行callback
-   */
-  it("only watch registered property", function () {
-    const result = [];
-    const callback = (newValue, oldValue, propertyName, target) => {
-      result.push(newValue, oldValue, propertyName, target);
-    };
-    const view = new Accessor();
-    view.zoom = 4;
-    view.watch("scale", callback);
-    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,19 +0,0 @@
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "module": "Node16",
-    "target": "ESNext",
-    "sourceMap": false,
-    "rootDir": "./src",
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "declaration": true,
-    "skipLibCheck": true,
-    "moduleResolution": "node16",
-    "verbatimModuleSyntax": true
-  },
-  "include": [
-    "src/**/*.ts",
-  ],
-  "exclude": []
-}