@gby/destroyable 1.0.0

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

@@ -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; [FunDestroyer](./destroyable.fundestroyer.md)
+
+## FunDestroyer type
+
+函数销毁者
+
+**Signature:**
+
+```typescript
+export type FunDestroyer = () => void;
+```

package/doc/api/destroyable.md

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

@@ -0,0 +1,33 @@
+<!-- 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): {
+        [x: string]: 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>;
+    };
+} & typeof EventEmitter
+```

package/doc/api/destroyable.nodedestroyableclass.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; [NodeDestroyableClass](./destroyable.nodedestroyableclass.md)
+
+## NodeDestroyableClass type
+
+NodeDestroyable 类的类型
+
+**Signature:**
+
+```typescript
+export type NodeDestroyableClass = typeof NodeDestroyable;
+```
+**References:** [NodeDestroyable](./destroyable.nodedestroyable.md)
+

package/doc/api/destroyable.throwondestroyed.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; [throwOnDestroyed](./destroyable.throwondestroyed.md)
+
+## throwOnDestroyed() function
+
+调用已销对象的时抛出错误
+
+**Signature:**
+
+```typescript
+export declare function throwOnDestroyed(): void;
+```
+**Returns:**
+
+void
+

package/doc/api/destroyable.webdestroyable.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@gby/destroyable](./destroyable.md) &gt; [WebDestroyable](./destroyable.webdestroyable.md)
+
+## WebDestroyable variable
+
+WebDestroyable 类对象
+
+**Signature:**
+
+```typescript
+WebDestroyable: {
+    new (...args: any): {
+        [x: string]: 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>;
+    };
+} & typeof EventBus
+```

package/doc/api/destroyable.webdestroyableclass.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; [WebDestroyableClass](./destroyable.webdestroyableclass.md)
+
+## WebDestroyableClass type
+
+WebDestroyable 类的类型
+
+**Signature:**
+
+```typescript
+export type WebDestroyableClass = typeof WebDestroyable;
+```
+**References:** [WebDestroyable](./destroyable.webdestroyable.md)
+

package/doc/api/index.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+<table><thead><tr><th>
+
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@gby/destroyable](./destroyable.md)
+
+
+</td><td>
+
+可销毁的
+
+
+</td></tr>
+</tbody></table>

package/doc//346/225/231/347/250/213.md

@@ -0,0 +1,7 @@
+[API接口文档]: ./api/index.md
+
+> 由于时间关系，暂时还未编写教程，以后会抽空补齐。详情可查看[API接口文档][]。
+
+> 开源不易，还望多多支持！💖 💖 💖 
+
+![赞赏码](https://i.loli.net/2020/04/08/PGsAEqdJCin1oQL.jpg)

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@gby/destroyable",
+  "version": "1.0.0",
+  "description": "@gby/destroyable 提供了用于构建可销毁对象的类的基类，用于使得地管理可销毁对象的生命周期",
+  "main": "./dist/index.umd.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "require": "./dist/index.umd.cjs",
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "homepage": "https://github.com/GuoBinyong/destroyable#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GuoBinyong/destroyable"
+  },
+  "bugs": {
+    "url": "https://github.com/GuoBinyong/destroyable/issues",
+    "email": "guobinyong@qq.com"
+  },
+  "keywords": [
+    "destroyable",
+    "destroy",
+    "销毁"
+  ],
+  "author": {
+    "name": "郭斌勇",
+    "email": "guobinyong@qq.com"
+  },
+  "license": "MIT",
+  "files": [
+    "dist",
+    "types",
+    "docs/[^.]*",
+    "doc/[^.]*"
+  ],
+  "devDependencies": {
+    "@microsoft/api-documenter": "latest",
+    "@microsoft/api-extractor": "latest",
+    "@types/node": "^24.3.0",
+    "build-tls": "latest",
+    "dts-bundle-generator": "latest",
+    "package-tls": "latest",
+    "rollup-plugin-preserve-shebang": "latest",
+    "typescript": "latest",
+    "vite": "latest",
+    "vite-node": "latest"
+  },
+  "dependencies": {
+    "@gby/event-bus": "^1.2.3"
+  },
+  "scripts": {
+    "serve": "vite",
+    "dev": "vite-node -w src/index.ts",
+    "dev:bin": "vite-node src/bin.ts",
+    "build": "vite build",
+    "bunch": "vite build --mode bunch",
+    "debug": "debug=true vite build",
+    "debug:bunch": "debug=true vite build --mode bunch",
+    "exe": "bun build --compile --minify ./src/bin.ts  --outfile ./exe/destroyable",
+    "exe:win": "bun build --compile --minify --target=bun-windows-x64 ./src/bin.ts  --outfile ./exe/destroyable_win",
+    "exe:linux": "bun build --compile --minify --target=bun-linux-x64 ./src/bin.ts  --outfile ./exe/destroyable_linux",
+    "exe:mac": "bun build --compile --minify --target=bun-darwin-arm64 ./src/bin.ts  --outfile ./exe/destroyable_mac",
+    "preview": "vite preview",
+    "api": "api-extractor run -c api-extractor.jsonc -l -v",
+    "doc": "api-documenter markdown -i ./temp -o doc/api",
+    "apidoc": "npm run api ; npm run doc"
+  }
+}