@gby/destroyable 1.0.0

package/dist/index.js

@@ -0,0 +1,229 @@
+var a = Object.defineProperty;
+var l = (t, e, r) => e in t ? a(t, e, { enumerable: !0, configurable: !0, writable: !0, value: r }) : t[e] = r;
+var o = (t, e, r) => l(t, typeof e != "symbol" ? e + "" : e, r);
+import { EventBus as f } from "@gby/event-bus";
+import { EventEmitter as p } from "node:events";
+class _ {
+  constructor() {
+    o(this, "_isDestroyed", !1);
+    /**
+     * 销毁者
+     */
+    o(this, "_destroyers", []);
+  }
+  /**
+   * 是否已经销毁
+   */
+  get isDestroyed() {
+    return this._isDestroyed;
+  }
+  /**
+   * 添加销毁者
+   * @param fun 
+   * @returns 返回销毁者的顺序
+   */
+  disposeFun(e) {
+    return this._destroyers.push(e), e;
+  }
+  /**
+   * 取消销毁者函数
+   * @param fun 
+   * @returns 
+   */
+  cancelDisposeFun(e) {
+    const r = this._destroyers.indexOf(e);
+    return this._destroyers.splice(r, 1), e;
+  }
+  /**
+   * 添加销毁对象
+   * @param obj 
+   * @param sync - 表示是否使用  `obj.destroy()` 方法进行销毁；默认使用   `obj.destroyAsync()` 方法进行销毁
+   * @returns 
+   */
+  disposeObj(e, r) {
+    const n = r ? function() {
+      return e.destroy();
+    } : function() {
+      return e.destroyAsync();
+    };
+    return this.disposeFun(n), e.__destroyable_destroyer = n, e;
+  }
+  /**
+   * 取消销毁者函数
+   * @param fun 
+   * @returns 
+   */
+  cancelDisposeObj(e) {
+    const r = e.__destroyable_destroyer;
+    return r && this.cancelDisposeFun(r), e;
+  }
+  dispose(e, r) {
+    return typeof e == "function" ? this.disposeFun(e) : this.disposeObj(e, r);
+  }
+  cancelDispose(e) {
+    return typeof e == "function" ? this.cancelDisposeFun(e) : this.cancelDisposeObj(e);
+  }
+  /**
+   * 自己的销毁方法
+   * @remarks
+   * 子类根据需要进行重载
+   */
+  destroyThis() {
+  }
+  /**
+   * 销毁
+   */
+  destroy() {
+    if (this.isDestroyed) return !0;
+    let e = this._destroyers.length;
+    for (; --e >= 0; )
+      try {
+        this._destroyers[e]();
+      } catch {
+      }
+    this._destroyers.length = 0, this.destroyThis(), u(this);
+  }
+  /**
+   * 异步销毁
+   * @remarks
+   * 会依次执行销毁，并且只有上一个销毁完成之后才会执行下一个销毁
+   */
+  async destroyAsync() {
+    if (this.isDestroyed) return !0;
+    let e = this._destroyers.length;
+    for (; --e >= 0; )
+      try {
+        await this._destroyers[e]();
+      } catch {
+      }
+    this._destroyers.length = 0, await this.destroyThis(), u(this);
+  }
+}
+function y() {
+  throw "已销毁";
+}
+function x(t) {
+  for (var e in t)
+    typeof t[e] == "function" && (t[e] = y);
+  return t._isDestroyed = !0, !0;
+}
+function u(t) {
+  for (var e in t)
+    !(e in _.prototype) && typeof t[e] == "function" && (t[e] = y);
+  return t._isDestroyed = !0, !0;
+}
+function c(t) {
+  class e extends t {
+    constructor() {
+      super(...arguments);
+      o(this, "_isDestroyed", !1);
+      /**
+       * 销毁者
+       */
+      o(this, "_destroyers", []);
+    }
+    /**
+     * 是否已经销毁
+     */
+    get isDestroyed() {
+      return this._isDestroyed;
+    }
+    /**
+     * 添加销毁者
+     * @param fun 
+     * @returns 返回销毁者的顺序
+     */
+    disposeFun(s) {
+      return this._destroyers.push(s), s;
+    }
+    /**
+     * 取消销毁者函数
+     * @param fun 
+     * @returns 
+     */
+    cancelDisposeFun(s) {
+      const i = this._destroyers.indexOf(s);
+      return this._destroyers.splice(i, 1), s;
+    }
+    /**
+     * 添加销毁对象
+     * @param obj 
+     * @param sync - 表示是否使用  `obj.destroy()` 方法进行销毁；默认使用   `obj.destroyAsync()` 方法进行销毁
+     * @returns 
+     */
+    disposeObj(s, i) {
+      const h = i ? function() {
+        return s.destroy();
+      } : function() {
+        return s.destroyAsync();
+      };
+      return this.disposeFun(h), s.__destroyable_destroyer = h, s;
+    }
+    /**
+     * 取消销毁者函数
+     * @param fun 
+     * @returns 
+     */
+    cancelDisposeObj(s) {
+      const i = s.__destroyable_destroyer;
+      return i && this.cancelDisposeFun(i), s;
+    }
+    dispose(s, i) {
+      return typeof s == "function" ? this.disposeFun(s) : this.disposeObj(s, i);
+    }
+    cancelDispose(s) {
+      return typeof s == "function" ? this.cancelDisposeFun(s) : this.cancelDisposeObj(s);
+    }
+    /**
+     * 自己的销毁方法
+     * @remarks
+     * 子类根据需要进行重载
+     */
+    destroyThis() {
+    }
+    /**
+     * 销毁
+     */
+    destroy() {
+      if (this.isDestroyed) return !0;
+      let s = this._destroyers.length;
+      for (; --s >= 0; )
+        try {
+          this._destroyers[s]();
+        } catch {
+        }
+      this._destroyers.length = 0, this.destroyThis(), r(this);
+    }
+    /**
+     * 异步销毁
+     * @remarks
+     * 会依次执行销毁，并且只有上一个销毁完成之后才会执行下一个销毁
+     */
+    async destroyAsync() {
+      if (this.isDestroyed) return !0;
+      let s = this._destroyers.length;
+      for (; --s >= 0; )
+        try {
+          await this._destroyers[s]();
+        } catch {
+        }
+      this._destroyers.length = 0, await this.destroyThis(), r(this);
+    }
+  }
+  function r(n) {
+    for (var d in n)
+      !(d in e.prototype) && typeof n[d] == "function" && (n[d] = y);
+    return n._isDestroyed = !0, !0;
+  }
+  return e;
+}
+const T = c(f), m = c(p);
+export {
+  _ as Destroyable,
+  m as NodeDestroyable,
+  T as WebDestroyable,
+  c as createDestroyableSubClass,
+  u as destroyDestroyable,
+  x as destroyObject,
+  y as throwOnDestroyed
+};

package/dist/index.umd.cjs

@@ -0,0 +1 @@
+(function(t,r){typeof exports=="object"&&typeof module<"u"?r(exports,require("@gby/event-bus"),require("node:events")):typeof define=="function"&&define.amd?define(["exports","@gby/event-bus","node:events"],r):(t=typeof globalThis<"u"?globalThis:t||self,r(t.Destroyable={},t.eventBus,t.node_events))})(this,function(t,r,y){"use strict";var g=Object.defineProperty;var v=(t,r,y)=>r in t?g(t,r,{enumerable:!0,configurable:!0,writable:!0,value:y}):t[r]=y;var u=(t,r,y)=>v(t,typeof r!="symbol"?r+"":r,y);class a{constructor(){u(this,"_isDestroyed",!1);u(this,"_destroyers",[])}get isDestroyed(){return this._isDestroyed}disposeFun(e){return this._destroyers.push(e),e}cancelDisposeFun(e){const i=this._destroyers.indexOf(e);return this._destroyers.splice(i,1),e}disposeObj(e,i){const d=i?function(){return e.destroy()}:function(){return e.destroyAsync()};return this.disposeFun(d),e.__destroyable_destroyer=d,e}cancelDisposeObj(e){const i=e.__destroyable_destroyer;return i&&this.cancelDisposeFun(i),e}dispose(e,i){return typeof e=="function"?this.disposeFun(e):this.disposeObj(e,i)}cancelDispose(e){return typeof e=="function"?this.cancelDisposeFun(e):this.cancelDisposeObj(e)}destroyThis(){}destroy(){if(this.isDestroyed)return!0;let e=this._destroyers.length;for(;--e>=0;)try{this._destroyers[e]()}catch{}this._destroyers.length=0,this.destroyThis(),f(this)}async destroyAsync(){if(this.isDestroyed)return!0;let e=this._destroyers.length;for(;--e>=0;)try{await this._destroyers[e]()}catch{}this._destroyers.length=0,await this.destroyThis(),f(this)}}function h(){throw"已销毁"}function D(n){for(var e in n)typeof n[e]=="function"&&(n[e]=h);return n._isDestroyed=!0,!0}function f(n){for(var e in n)!(e in a.prototype)&&typeof n[e]=="function"&&(n[e]=h);return n._isDestroyed=!0,!0}function l(n){class e extends n{constructor(){super(...arguments);u(this,"_isDestroyed",!1);u(this,"_destroyers",[])}get isDestroyed(){return this._isDestroyed}disposeFun(s){return this._destroyers.push(s),s}cancelDisposeFun(s){const o=this._destroyers.indexOf(s);return this._destroyers.splice(o,1),s}disposeObj(s,o){const p=o?function(){return s.destroy()}:function(){return s.destroyAsync()};return this.disposeFun(p),s.__destroyable_destroyer=p,s}cancelDisposeObj(s){const o=s.__destroyable_destroyer;return o&&this.cancelDisposeFun(o),s}dispose(s,o){return typeof s=="function"?this.disposeFun(s):this.disposeObj(s,o)}cancelDispose(s){return typeof s=="function"?this.cancelDisposeFun(s):this.cancelDisposeObj(s)}destroyThis(){}destroy(){if(this.isDestroyed)return!0;let s=this._destroyers.length;for(;--s>=0;)try{this._destroyers[s]()}catch{}this._destroyers.length=0,this.destroyThis(),i(this)}async destroyAsync(){if(this.isDestroyed)return!0;let s=this._destroyers.length;for(;--s>=0;)try{await this._destroyers[s]()}catch{}this._destroyers.length=0,await this.destroyThis(),i(this)}}function i(d){for(var c in d)!(c in e.prototype)&&typeof d[c]=="function"&&(d[c]=h);return d._isDestroyed=!0,!0}return e}const _=l(r.EventBus),b=l(y.EventEmitter);t.Destroyable=a,t.NodeDestroyable=b,t.WebDestroyable=_,t.createDestroyableSubClass=l,t.destroyDestroyable=f,t.destroyObject=D,t.throwOnDestroyed=h,Object.defineProperty(t,Symbol.toStringTag,{value:"Module"})});

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.52.8"
+    }
+  ]
+}

package/doc/api/destroyable.createdestroyablesubclass.md

@@ -0,0 +1,76 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [createDestroyableSubClass](./destroyable.createdestroyablesubclass.md)
+
+## createDestroyableSubClass() function
+
+创建可销毁的子类
+
+**Signature:**
+
+```typescript
+export declare function createDestroyableSubClass<P extends new (...args: any) => any>(ParentClass: P): {
+    new (...args: any): {
+        [x: string]: any;
+        readonly isDestroyed: boolean;
+        _isDestroyed: boolean;
+        _destroyers: FunDestroyer[];
+        disposeFun<T extends FunDestroyer>(fun: T): T;
+        cancelDisposeFun<T extends FunDestroyer>(fun: T): T;
+        disposeObj<T extends /*elided*/ any>(obj: T, sync?: boolean): T;
+        cancelDisposeObj<T extends /*elided*/ any>(obj: T): T;
+        dispose<T extends FunDestroyer>(fun: T): T;
+        dispose<T extends /*elided*/ any>(obj: T, asyncDestroy?: boolean): T;
+        dispose<T extends /*elided*/ any | FunDestroyer>(objOrFun: T, asyncDestroy?: boolean): T;
+        cancelDispose<T extends FunDestroyer>(fun: T): T;
+        cancelDispose<T extends /*elided*/ any>(obj: T): T;
+        cancelDispose<T extends /*elided*/ any | FunDestroyer>(objOrFun: T): T;
+        destroyThis(): void;
+        destroy(): true | undefined;
+        destroyAsync(): Promise<true | undefined>;
+    };
+} & P;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+ParentClass
+
+
+</td><td>
+
+P
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+{ new (...args: any): { \[x: string\]: any; readonly isDestroyed: boolean; \_isDestroyed: boolean; \_destroyers: [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->\[\]; disposeFun&lt;T extends [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(fun: T): T; cancelDisposeFun&lt;T extends [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(fun: T): T; disposeObj&lt;T extends /\*elided\*/ any&gt;(obj: T, sync?: boolean): T; cancelDisposeObj&lt;T extends /\*elided\*/ any&gt;(obj: T): T; dispose&lt;T extends [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(fun: T): T; dispose&lt;T extends /\*elided\*/ any&gt;(obj: T, asyncDestroy?: boolean): T; dispose&lt;T extends /\*elided\*/ any \| [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(objOrFun: T, asyncDestroy?: boolean): T; cancelDispose&lt;T extends [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(fun: T): T; cancelDispose&lt;T extends /\*elided\*/ any&gt;(obj: T): T; cancelDispose&lt;T extends /\*elided\*/ any \| [FunDestroyer](./destroyable.fundestroyer.md)<!-- -->&gt;(objOrFun: T): T; destroyThis(): void; destroy(): true \| undefined; destroyAsync(): Promise&lt;true \| undefined&gt;; }; } &amp; P
+
+
+## Remarks
+
+用于根据传入的父类 动态生成可可销毁的子类
+

package/doc/api/destroyable.destroyable._destroyers.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [\_destroyers](./destroyable.destroyable._destroyers.md)
+
+## Destroyable.\_destroyers property
+
+销毁者
+
+**Signature:**
+
+```typescript
+_destroyers: FunDestroyer[];
+```

package/doc/api/destroyable.destroyable._isdestroyed.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [\_isDestroyed](./destroyable.destroyable._isdestroyed.md)
+
+## Destroyable.\_isDestroyed property
+
+**Signature:**
+
+```typescript
+_isDestroyed: boolean;
+```

package/doc/api/destroyable.destroyable.canceldispose.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [cancelDispose](./destroyable.destroyable.canceldispose.md)
+
+## Destroyable.cancelDispose() method
+
+**Signature:**
+
+```typescript
+cancelDispose<T extends FunDestroyer>(fun: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fun
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+

package/doc/api/destroyable.destroyable.canceldispose_1.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [cancelDispose](./destroyable.destroyable.canceldispose_1.md)
+
+## Destroyable.cancelDispose() method
+
+**Signature:**
+
+```typescript
+cancelDispose<T extends Destroyable>(obj: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+

package/doc/api/destroyable.destroyable.canceldispose_2.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [cancelDispose](./destroyable.destroyable.canceldispose_2.md)
+
+## Destroyable.cancelDispose() method
+
+**Signature:**
+
+```typescript
+cancelDispose<T extends Destroyable | FunDestroyer>(objOrFun: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+objOrFun
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+

package/doc/api/destroyable.destroyable.canceldisposefun.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [cancelDisposeFun](./destroyable.destroyable.canceldisposefun.md)
+
+## Destroyable.cancelDisposeFun() method
+
+取消销毁者函数
+
+**Signature:**
+
+```typescript
+cancelDisposeFun<T extends FunDestroyer>(fun: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+fun
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+
+

package/doc/api/destroyable.destroyable.canceldisposeobj.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [cancelDisposeObj](./destroyable.destroyable.canceldisposeobj.md)
+
+## Destroyable.cancelDisposeObj() method
+
+取消销毁者函数
+
+**Signature:**
+
+```typescript
+cancelDisposeObj<T extends Destroyable>(obj: T): T;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+
+

package/doc/api/destroyable.destroyable.destroy.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [destroy](./destroyable.destroyable.destroy.md)
+
+## Destroyable.destroy() method
+
+销毁
+
+**Signature:**
+
+```typescript
+destroy(): true | undefined;
+```
+**Returns:**
+
+true \| undefined
+

package/doc/api/destroyable.destroyable.destroyasync.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [destroyAsync](./destroyable.destroyable.destroyasync.md)
+
+## Destroyable.destroyAsync() method
+
+异步销毁
+
+**Signature:**
+
+```typescript
+destroyAsync(): Promise<true | undefined>;
+```
+**Returns:**
+
+Promise&lt;true \| undefined&gt;
+
+## Remarks
+
+会依次执行销毁，并且只有上一个销毁完成之后才会执行下一个销毁
+

package/doc/api/destroyable.destroyable.destroythis.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [Destroyable](./destroyable.destroyable.md) &gt; [destroyThis](./destroyable.destroyable.destroythis.md)
+
+## Destroyable.destroyThis() method
+
+自己的销毁方法
+
+**Signature:**
+
+```typescript
+destroyThis(): void;
+```
+**Returns:**
+
+void
+
+## Remarks
+
+子类根据需要进行重载
+