lyb-js 1.4.2 → 1.5.0

package/Misc/LibJsClassObservable.d.ts

@@ -0,0 +1,51 @@
+/** @description 类属性监听器
+ * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsClassObservable-类属性监听器
+ */
+export declare class LibJsClassObservable<T extends Record<string, any>> {
+    /** 可监听的对象 */
+    private data;
+    /** 监听器 */
+    private listeners;
+    /** 监听函数索引ID */
+    private index;
+    /**
+     * @param initialData 监听的数据
+     */
+    constructor(initialData: T);
+    /** @description 获取值、
+     * @param key 要获取的键
+     * @returns 对应的值
+     */
+    getValue<K extends keyof T>(key: K): T[K];
+    /** @description 设置值
+     * @param key 要设置的键
+     * @param value 要设置的值
+     * @param immediately 是否立即通知监听器
+     * @returns 设置后的值
+     */
+    setValue<K extends keyof T, V extends T[K]>(key: K, value: V, immediately?: boolean): V;
+    /** @description 监听值
+     * @param key 要监听的键
+     * @param callback 回调函数
+     * @param immediately 是否立即触发一次回调函数
+     * @returns 取消监听的函数
+     */
+    onValue<K extends keyof T>(key: K, callback: (newValue: T[K], oldValue: T[K]) => void, immediately?: boolean): () => void;
+    /** @description 触发某个键名的所有回调函数，适用于同时监听了多个值的场景，用于切换要显示的值，或者延迟在特定时机通知监听器
+     * @param key 要触发的键名
+     * @returns 触发的键值
+     */
+    updateFake<K extends keyof T>(key: K): T[K];
+    /** @description 数字类型的键值累加或累减
+     * @param key 要累加或累减的键
+     * @param type 要累加还是要累减
+     * @param value 要累加或累减的值
+     * @param immediately 是否立即通知监听器
+     */
+    setNumberValue<K extends keyof T>(key: K, type: "add" | "sub", value?: number, immediately?: boolean): number;
+    /** @description 针对布尔类型的键值取反
+     * @param key 要取反的键
+     * @param immediately 是否立即通知监听器
+     */
+    setBooleanValue<K extends keyof T>(key: K, immediately?: boolean): boolean;
+}

package/Misc/LibJsClassObservable.js

@@ -0,0 +1,93 @@
+import { libJsDecimal } from "../Math/LibJsDecimal";
+/** @description 类属性监听器
+ * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsClassObservable-类属性监听器
+ */
+export class LibJsClassObservable {
+    /**
+     * @param initialData 监听的数据
+     */
+    constructor(initialData) {
+        /** 监听器 */
+        this.listeners = new Map();
+        /** 监听函数索引ID */
+        this.index = 0;
+        this.data = Object.assign({}, initialData);
+    }
+    /** @description 获取值、
+     * @param key 要获取的键
+     * @returns 对应的值
+     */
+    getValue(key) {
+        return this.data[key];
+    }
+    /** @description 设置值
+     * @param key 要设置的键
+     * @param value 要设置的值
+     * @param immediately 是否立即通知监听器
+     * @returns 设置后的值
+     */
+    setValue(key, value, immediately = true) {
+        var _a;
+        const oldValue = this.data[key];
+        if (oldValue === value)
+            return value;
+        this.data[key] = value;
+        immediately &&
+            ((_a = this.listeners.get(key)) === null || _a === void 0 ? void 0 : _a.forEach((fn) => fn(value, oldValue)));
+        return value;
+    }
+    /** @description 监听值
+     * @param key 要监听的键
+     * @param callback 回调函数
+     * @param immediately 是否立即触发一次回调函数
+     * @returns 取消监听的函数
+     */
+    onValue(key, callback, immediately = true) {
+        const id = this.index++;
+        if (!this.listeners.has(key)) {
+            this.listeners.set(key, new Map());
+        }
+        this.listeners.get(key).set(id, callback);
+        immediately && callback(this.data[key], this.data[key]);
+        return () => {
+            this.listeners.get(key).delete(id);
+        };
+    }
+    /** @description 触发某个键名的所有回调函数，适用于同时监听了多个值的场景，用于切换要显示的值，或者延迟在特定时机通知监听器
+     * @param key 要触发的键名
+     * @returns 触发的键值
+     */
+    updateFake(key) {
+        var _a;
+        const value = this.data[key];
+        (_a = this.listeners.get(key)) === null || _a === void 0 ? void 0 : _a.forEach((fn) => fn(value, value));
+        return value;
+    }
+    /** @description 数字类型的键值累加或累减
+     * @param key 要累加或累减的键
+     * @param type 要累加还是要累减
+     * @param value 要累加或累减的值
+     * @param immediately 是否立即通知监听器
+     */
+    setNumberValue(key, type, value = 1, immediately = true) {
+        let v;
+        if (type === "add") {
+            v = libJsDecimal(this.data[key], value, "+");
+            this.setValue(key, v, immediately);
+        }
+        else {
+            v = libJsDecimal(this.data[key], value, "-");
+            this.setValue(key, v, immediately);
+        }
+        return v;
+    }
+    /** @description 针对布尔类型的键值取反
+     * @param key 要取反的键
+     * @param immediately 是否立即通知监听器
+     */
+    setBooleanValue(key, immediately = true) {
+        const v = !this.data[key];
+        this.setValue(key, v, immediately);
+        return v;
+    }
+}

package/Misc/LibJsEmitter.d.ts

@@ -1,5 +1,5 @@
-/** @description 事件管理器
- * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件管理器
+/** @description 事件发射器
+ * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件发射器
  */
 export declare const LibJsEmitter: <T extends Record<string, any>>() => {
     on: <K extends keyof T>(event: K, listener: T[K] extends any[] ? (...args: T[K]) => void : (arg: T[K]) => void) => void;

package/Misc/LibJsEmitter.js

@@ -1,5 +1,5 @@
-/** @description 事件管理器
- * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件管理器
+/** @description 事件发射器
+ * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件发射器
  */
 export const LibJsEmitter = () => {
     const _eventMap = new Map();

package/README.md

@@ -145,7 +145,9 @@ console.log(t); //"string"
 
 \- [LibJsNumberStepper-数字步进器](#LibJsNumberStepper-数字步进器)
 
-\- [LibJsEmitter-事件管理器](#LibJsEmitter-事件管理器)
+\- [LibJsEmitter-事件发射器](#LibJsEmitter-事件发射器)
+
+\- [LibJsClassObservable-类属性监听器](#LibJsClassObservable-类属性监听器)
 
 
 ### Random-随机
@@ -565,7 +567,7 @@ stepper.updateIndex(5); // 更新索引为5
 stepper.down("sub"); // 索引减1
 ```
 
-### LibJsEmitter-事件管理器
+### LibJsEmitter-事件发射器
 
 > 发布-订阅模式
 
@@ -592,6 +594,56 @@ $bus.off("play");
 $bus.off("stop");
 ```
 
+### LibJsClassObservable-类属性监听器
+
+> 监听`class`的属性值更改
+
+```ts
+import { LibJsClassObservable } from "@/utils/LibJsClassObservable";
+
+export type WinTextType = "luck" | "win" | "reset";
+
+interface Static {
+  /** 用户ID */
+  userID: number;
+  /** 是否为学生 */
+  sdutent: boolean;
+  /** 年龄 */
+  age: number;
+}
+
+/** @description 静态数据 */
+export class DataStore extends LibJsClassObservable<Static> {
+  constructor() {
+    super({
+      userID: 0,
+      sdutent: true,
+      age: 18,
+    });
+  }
+}
+
+const dataStore = new DataStore()
+
+//获取
+const userID = dataStore.getValue("userID"); //0
+
+//更改
+const userID = dataStore.setValue("userID", 1); //1
+
+//Boolean 类型取反
+const stdutent = dataStore.setBooleanValue("sdutent"); //false
+
+//数字类型累加
+const stdutent = dataStore.setNumberValue("age"); //19
+
+//手动触发指定属性监听的所有回调，配合 setValue 第三参数为false，即不自动触发监听的时候，可手动触发
+dataStore.setValue("userID", 3, false);
+setTimeout(()=>{
+  dataStore.updateFake("userID");
+}, 1000)
+```
+
 ## Random-随机
 
 ### LibJsProbabilityResult-概率触发

package/libJs.d.ts

@@ -1,4 +1,5 @@
 import { LibJsNumberStepper } from "./Misc/LibJsNumberStepper";
+import { LibJsClassObservable } from "./Misc/LibJsClassObservable";
 /** @description 基础方法 */
 export declare const Base: {
     /**
@@ -243,14 +244,6 @@ export declare const Misc: {
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNumberStepper-数字步进器
      */
     LibJsNumberStepper: typeof LibJsNumberStepper;
-    /** @description 事件管理器
-     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件管理器
-     */
-    LibJsEmitter: <T extends Record<string, any>>() => {
-        on: <K extends keyof T>(event: K, listener: T[K] extends any[] ? (...args: T[K]) => void : (arg: T[K]) => void) => void;
-        emit: <K extends keyof T>(event: K, ...args: T[K] extends any[] ? T[K] : [T[K]]) => void;
-        off: <K extends keyof T>(event: K, listener?: T[K] extends any[] ? (...args: T[K]) => void : (arg: T[K]) => void) => void;
-    };
     /** @description 线性插值
      * @param start 当 value = 0 时，返回 start
      * @param end 当 value = 1 时，返回 end
@@ -265,6 +258,18 @@ export declare const Misc: {
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNormalizeInRange-范围归一化
      */
     LibJsNormalizeInRange: (start: number, end: number, value: number) => number;
+    /** @description 事件发射器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件发射器
+     */
+    LibJsEmitter: <T extends Record<string, any>>() => {
+        on: <K extends keyof T>(event: K, listener: T[K] extends any[] ? (...args: T[K]) => void : (arg: T[K]) => void) => void;
+        emit: <K extends keyof T>(event: K, ...args: T[K] extends any[] ? T[K] : [T[K]]) => void;
+        off: <K extends keyof T>(event: K, listener?: T[K] extends any[] ? (...args: T[K]) => void : (arg: T[K]) => void) => void;
+    };
+    /** @description 类属性监听器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsClassObservable-类属性监听器
+     */
+    LibJsClassObservable: typeof LibJsClassObservable;
 };
 /** @description 随机相关方法 */
 export declare const Random: {

package/libJs.js

@@ -39,7 +39,8 @@ import { libJsSecondsFormatterChinese } from "./Formatter/LibJsSecondsFormatterC
 import { libJsCalculateExpression } from "./Math/LibJsCalculateExpression";
 import { LibJsEmitter } from "./Misc/LibJsEmitter";
 import { LibJsLerp } from "./Math/LibJsLerp";
-import { LibJsNormalizeInRange } from './Math/LibJsNormalizeInRange';
+import { LibJsNormalizeInRange } from "./Math/LibJsNormalizeInRange";
+import { LibJsClassObservable } from "./Misc/LibJsClassObservable";
 /** @description 基础方法 */
 export const Base = {
     /**
@@ -258,10 +259,6 @@ export const Misc = {
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNumberStepper-数字步进器
      */
     LibJsNumberStepper,
-    /** @description 事件管理器
-     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件管理器
-     */
-    LibJsEmitter,
     /** @description 线性插值
      * @param start 当 value = 0 时，返回 start
      * @param end 当 value = 1 时，返回 end
@@ -276,6 +273,14 @@ export const Misc = {
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNormalizeInRange-范围归一化
      */
     LibJsNormalizeInRange,
+    /** @description 事件发射器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件发射器
+     */
+    LibJsEmitter,
+    /** @description 类属性监听器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsClassObservable-类属性监听器
+     */
+    LibJsClassObservable,
 };
 /** @description 随机相关方法 */
 export const Random = {

package/lyb.js

@@ -3405,6 +3405,91 @@ ${log3.label}：`, log3.value];
   const LibJsNormalizeInRange = (start, end, value) => {
     return Math.max(0, Math.min((start - value) / (start - end), 1));
   };
+  class LibJsClassObservable {
+    /**
+     * @param initialData 监听的数据
+     */
+    constructor(initialData) {
+      this.listeners = /* @__PURE__ */ new Map();
+      this.index = 0;
+      this.data = { ...initialData };
+    }
+    /** @description 获取值、
+     * @param key 要获取的键
+     * @returns 对应的值
+     */
+    getValue(key) {
+      return this.data[key];
+    }
+    /** @description 设置值
+     * @param key 要设置的键
+     * @param value 要设置的值
+     * @param immediately 是否立即通知监听器
+     * @returns 设置后的值
+     */
+    setValue(key, value, immediately = true) {
+      var _a;
+      const oldValue = this.data[key];
+      if (oldValue === value)
+        return value;
+      this.data[key] = value;
+      immediately && ((_a = this.listeners.get(key)) == null ? void 0 : _a.forEach((fn) => fn(value, oldValue)));
+      return value;
+    }
+    /** @description 监听值
+     * @param key 要监听的键
+     * @param callback 回调函数
+     * @param immediately 是否立即触发一次回调函数
+     * @returns 取消监听的函数
+     */
+    onValue(key, callback, immediately = true) {
+      const id = this.index++;
+      if (!this.listeners.has(key)) {
+        this.listeners.set(key, /* @__PURE__ */ new Map());
+      }
+      this.listeners.get(key).set(id, callback);
+      immediately && callback(this.data[key], this.data[key]);
+      return () => {
+        this.listeners.get(key).delete(id);
+      };
+    }
+    /** @description 触发某个键名的所有回调函数，适用于同时监听了多个值的场景，用于切换要显示的值，或者延迟在特定时机通知监听器
+     * @param key 要触发的键名
+     * @returns 触发的键值
+     */
+    updateFake(key) {
+      var _a;
+      const value = this.data[key];
+      (_a = this.listeners.get(key)) == null ? void 0 : _a.forEach((fn) => fn(value, value));
+      return value;
+    }
+    /** @description 数字类型的键值累加或累减
+     * @param key 要累加或累减的键
+     * @param type 要累加还是要累减
+     * @param value 要累加或累减的值
+     * @param immediately 是否立即通知监听器
+     */
+    setNumberValue(key, type, value = 1, immediately = true) {
+      let v;
+      if (type === "add") {
+        v = libJsDecimal(this.data[key], value, "+");
+        this.setValue(key, v, immediately);
+      } else {
+        v = libJsDecimal(this.data[key], value, "-");
+        this.setValue(key, v, immediately);
+      }
+      return v;
+    }
+    /** @description 针对布尔类型的键值取反
+     * @param key 要取反的键
+     * @param immediately 是否立即通知监听器
+     */
+    setBooleanValue(key, immediately = true) {
+      const v = !this.data[key];
+      this.setValue(key, v, immediately);
+      return v;
+    }
+  }
   const Base = {
     /**
      * @description 返回数据类型
@@ -3616,10 +3701,6 @@ ${log3.label}：`, log3.value];
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNumberStepper-数字步进器
      */
     LibJsNumberStepper,
-    /** @description 事件管理器
-     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件管理器
-     */
-    LibJsEmitter,
     /** @description 线性插值
      * @param start 当 value = 0 时，返回 start
      * @param end 当 value = 1 时，返回 end
@@ -3633,7 +3714,15 @@ ${log3.label}：`, log3.value];
      * @param value 动态值
      * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsNormalizeInRange-范围归一化
      */
-    LibJsNormalizeInRange
+    LibJsNormalizeInRange,
+    /** @description 事件发射器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsEmitter-事件发射器
+     */
+    LibJsEmitter,
+    /** @description 类属性监听器
+     * @link 使用方法：https://www.npmjs.com/package/lyb-js#LibJsClassObservable-类属性监听器
+     */
+    LibJsClassObservable
   };
   const Random = {
     /** @description 百分比概率结果

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lyb-js",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "自用JS方法库",
   "license": "ISC",
   "type": "module",