@gby/destroyable 3.6.2 → 3.7.0

package/doc/api/destroyable.destroyable.md

@@ -1,287 +0,0 @@
-<!-- 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)
-
-## Destroyable class
-
-可销毁的对象
-
-**Signature:**
-
-```typescript
-export declare class Destroyable 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[\_destroyers](./destroyable.destroyable._destroyers.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FunDestroyer](./destroyable.fundestroyer.md)<!-- -->\[\]
-
-
-</td><td>
-
-销毁者
-
-
-</td></tr>
-<tr><td>
-
-[\_isDestroyed](./destroyable.destroyable._isdestroyed.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[isDestroyed](./destroyable.destroyable.isdestroyed.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-是否已经销毁
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[cancelDispose(fun)](./destroyable.destroyable.canceldispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[cancelDispose(obj)](./destroyable.destroyable.canceldispose_1.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[cancelDispose(objOrFun)](./destroyable.destroyable.canceldispose_2.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[cancelDisposeFun(fun)](./destroyable.destroyable.canceldisposefun.md)
-
-
-</td><td>
-
-
-</td><td>
-
-取消销毁者函数
-
-
-</td></tr>
-<tr><td>
-
-[cancelDisposeObj(obj)](./destroyable.destroyable.canceldisposeobj.md)
-
-
-</td><td>
-
-
-</td><td>
-
-取消销毁者函数
-
-
-</td></tr>
-<tr><td>
-
-[destroy()](./destroyable.destroyable.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-销毁
-
-
-</td></tr>
-<tr><td>
-
-[destroyAsync()](./destroyable.destroyable.destroyasync.md)
-
-
-</td><td>
-
-
-</td><td>
-
-异步销毁
-
-
-</td></tr>
-<tr><td>
-
-[destroyThis()](./destroyable.destroyable.destroythis.md)
-
-
-</td><td>
-
-
-</td><td>
-
-自己的销毁方法
-
-
-</td></tr>
-<tr><td>
-
-[dispose(fun)](./destroyable.destroyable.dispose.md)
-
-
-</td><td>
-
-
-</td><td>
-
-添加销毁函数或销毁对象
-
-
-</td></tr>
-<tr><td>
-
-[dispose(obj, asyncDestroy)](./destroyable.destroyable.dispose_1.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[dispose(objOrFun, asyncDestroy)](./destroyable.destroyable.dispose_2.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[disposeFun(fun)](./destroyable.destroyable.disposefun.md)
-
-
-</td><td>
-
-
-</td><td>
-
-添加销毁者
-
-
-</td></tr>
-<tr><td>
-
-[disposeObj(obj, sync)](./destroyable.destroyable.disposeobj.md)
-
-
-</td><td>
-
-
-</td><td>
-
-添加销毁对象
-
-
-</td></tr>
-</tbody></table>

package/doc/api/destroyable.destroyablesub.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [DestroyableSub](./destroyable.destroyablesub.md)
-
-## DestroyableSub type
-
-createDestroyableSubClass 创建的类的实例类型
-
-**Signature:**
-
-```typescript
-export type DestroyableSub<ParentClass extends new (...args: any) => Object> = InstanceType<DestroyableSubClass<ParentClass>>;
-```
-**References:** [DestroyableSubClass](./destroyable.destroyablesubclass.md)
-

package/doc/api/destroyable.destroyablesubclass.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [DestroyableSubClass](./destroyable.destroyablesubclass.md)
-
-## DestroyableSubClass type
-
-createDestroyableSubClass 创建的类的类型
-
-**Signature:**
-
-```typescript
-export type DestroyableSubClass<ParentClass extends new (...args: any) => Object> = ReturnType<typeof createDestroyableSubClass<ParentClass>>;
-```

package/doc/api/destroyable.destroydestroyable.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [destroyDestroyable](./destroyable.destroydestroyable.md)
-
-## destroyDestroyable() function
-
-销毁 Destroyable 对象
-
-**Signature:**
-
-```typescript
-export declare function destroyDestroyable(object: Destroyable): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-object
-
-
-</td><td>
-
-[Destroyable](./destroyable.destroyable.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-

package/doc/api/destroyable.destroyobject.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [destroyObject](./destroyable.destroyobject.md)
-
-## destroyObject() function
-
-销毁对象
-
-**Signature:**
-
-```typescript
-export declare function destroyObject(object: any): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-object
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-boolean
-
-

package/doc/api/destroyable.fundestroyer.md

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

package/doc/api/destroyable.md

@@ -1,225 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md)
-
-## destroyable package
-
-可销毁的
-
-## Remarks
-
-@<!-- -->gby/destroyable 提供了用于构建可销毁对象的类的基类，用于使得地管理可销毁对象的生命周期
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[Destroyable](./destroyable.destroyable.md)
-
-
-</td><td>
-
-可销毁的对象
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createDestroyableSubClass(ParentClass)](./destroyable.createdestroyablesubclass.md)
-
-
-</td><td>
-
-创建可销毁的子类
-
-
-</td></tr>
-<tr><td>
-
-[destroyDestroyable(object)](./destroyable.destroydestroyable.md)
-
-
-</td><td>
-
-销毁 Destroyable 对象
-
-
-</td></tr>
-<tr><td>
-
-[destroyObject(object)](./destroyable.destroyobject.md)
-
-
-</td><td>
-
-销毁对象
-
-
-</td></tr>
-<tr><td>
-
-[throwOnDestroyed()](./destroyable.throwondestroyed.md)
-
-
-</td><td>
-
-调用已销对象的时抛出错误
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[NodeDestroyable](./destroyable.nodedestroyable.md)
-
-
-</td><td>
-
-NodeDestroyable 类对象
-
-
-</td></tr>
-<tr><td>
-
-[WebDestroyable](./destroyable.webdestroyable.md)
-
-
-</td><td>
-
-WebDestroyable 类对象
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DestroyableSub](./destroyable.destroyablesub.md)
-
-
-</td><td>
-
-createDestroyableSubClass 创建的类的实例类型
-
-
-</td></tr>
-<tr><td>
-
-[DestroyableSubClass](./destroyable.destroyablesubclass.md)
-
-
-</td><td>
-
-createDestroyableSubClass 创建的类的类型
-
-
-</td></tr>
-<tr><td>
-
-[FunDestroyer](./destroyable.fundestroyer.md)
-
-
-</td><td>
-
-函数销毁者
-
-
-</td></tr>
-<tr><td>
-
-[NodeDestroyable](./destroyable.nodedestroyable.md)
-
-
-</td><td>
-
-NodeDestroyable 实例的类型
-
-
-</td></tr>
-<tr><td>
-
-[NodeDestroyableClass](./destroyable.nodedestroyableclass.md)
-
-
-</td><td>
-
-NodeDestroyable 类的类型
-
-
-</td></tr>
-<tr><td>
-
-[WebDestroyable](./destroyable.webdestroyable.md)
-
-
-</td><td>
-
-WebDestroyable 实例的类型
-
-
-</td></tr>
-<tr><td>
-
-[WebDestroyableClass](./destroyable.webdestroyableclass.md)
-
-
-</td><td>
-
-WebDestroyable 类的类型
-
-
-</td></tr>
-</tbody></table>

package/doc/api/destroyable.nodedestroyable.md

@@ -1,39 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [NodeDestroyable](./destroyable.nodedestroyable.md)
-
-## NodeDestroyable variable
-
-NodeDestroyable 类对象
-
-**Signature:**
-
-```typescript
-NodeDestroyable: {
-    new (...args: any): {
-        readonly isDestroyed: boolean;
-        _isDestroyed: boolean;
-        _destroyers: import("./Destroyable").FunDestroyer[];
-        disposeFun<T extends import("./Destroyable").FunDestroyer>(fun: T): T;
-        cancelDisposeFun<T extends import("./Destroyable").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 import("./Destroyable").FunDestroyer>(fun: T): T;
-        dispose<T extends /*elided*/ any>(obj: T, asyncDestroy?: boolean): T;
-        dispose<T extends import("./Destroyable").FunDestroyer | /*elided*/ any>(objOrFun: T, asyncDestroy?: boolean): T;
-        cancelDispose<T extends import("./Destroyable").FunDestroyer>(fun: T): T;
-        cancelDispose<T extends /*elided*/ any>(obj: T): T;
-        cancelDispose<T extends import("./Destroyable").FunDestroyer | /*elided*/ any>(objOrFun: T): T;
-        destroyThis(): void;
-        destroy(): true | undefined;
-        destroyAsync(): Promise<true | undefined>;
-        constructor: Function;
-        toString(): string;
-        toLocaleString(): string;
-        valueOf(): Object;
-        hasOwnProperty(v: PropertyKey): boolean;
-        isPrototypeOf(v: Object): boolean;
-        propertyIsEnumerable(v: PropertyKey): boolean;
-    };
-} & typeof EventEmitter
-```

package/doc/api/destroyable.nodedestroyableclass.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [NodeDestroyableClass](./destroyable.nodedestroyableclass.md)
-
-## NodeDestroyableClass type
-
-NodeDestroyable 类的类型
-
-**Signature:**
-
-```typescript
-export type NodeDestroyableClass = typeof NodeDestroyable;
-```
-**References:** [NodeDestroyable](./destroyable.nodedestroyable.md)
-