@gby/destroyable 1.0.0

package/doc/api/destroyable.destroyable.dispose.md

@@ -0,0 +1,51 @@
+<!-- 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; [dispose](./destroyable.destroyable.dispose.md)
+
+## Destroyable.dispose() method
+
+添加销毁函数或销毁对象
+
+**Signature:**
+
+```typescript
+dispose<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.dispose_1.md

@@ -0,0 +1,65 @@
+<!-- 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; [dispose](./destroyable.destroyable.dispose_1.md)
+
+## Destroyable.dispose() method
+
+**Signature:**
+
+```typescript
+dispose<T extends Destroyable>(obj: T, asyncDestroy?: boolean): 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>
+<tr><td>
+
+asyncDestroy
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+

package/doc/api/destroyable.destroyable.dispose_2.md

@@ -0,0 +1,65 @@
+<!-- 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; [dispose](./destroyable.destroyable.dispose_2.md)
+
+## Destroyable.dispose() method
+
+**Signature:**
+
+```typescript
+dispose<T extends Destroyable | FunDestroyer>(objOrFun: T, asyncDestroy?: boolean): 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>
+<tr><td>
+
+asyncDestroy
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+

package/doc/api/destroyable.destroyable.disposefun.md

@@ -0,0 +1,53 @@
+<!-- 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; [disposeFun](./destroyable.destroyable.disposefun.md)
+
+## Destroyable.disposeFun() method
+
+添加销毁者
+
+**Signature:**
+
+```typescript
+disposeFun<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.disposeobj.md

@@ -0,0 +1,68 @@
+<!-- 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; [disposeObj](./destroyable.destroyable.disposeobj.md)
+
+## Destroyable.disposeObj() method
+
+添加销毁对象
+
+**Signature:**
+
+```typescript
+disposeObj<T extends Destroyable>(obj: T, sync?: boolean): 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>
+<tr><td>
+
+sync
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ 表示是否使用 `obj.destroy()` 方法进行销毁；默认使用 `obj.destroyAsync()` 方法进行销毁
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+T
+
+

package/doc/api/destroyable.destroyable.isdestroyed.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; [isDestroyed](./destroyable.destroyable.isdestroyed.md)
+
+## Destroyable.isDestroyed property
+
+是否已经销毁
+
+**Signature:**
+
+```typescript
+get isDestroyed(): boolean;
+```

package/doc/api/destroyable.destroyable.md

@@ -0,0 +1,287 @@
+<!-- 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

@@ -0,0 +1,15 @@
+<!-- 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) => any> = InstanceType<DestroyableSubClass<ParentClass>>;
+```
+**References:** [DestroyableSubClass](./destroyable.destroyablesubclass.md)
+

package/doc/api/destroyable.destroyablesubclass.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; [DestroyableSubClass](./destroyable.destroyablesubclass.md)
+
+## DestroyableSubClass type
+
+createDestroyableSubClass 创建的类的类型
+
+**Signature:**
+
+```typescript
+export type DestroyableSubClass<ParentClass extends new (...args: any) => any> = ReturnType<typeof createDestroyableSubClass<ParentClass>>;
+```

package/doc/api/destroyable.destroydestroyable.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; [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
+
+