@guanghechen/disposable 1.0.2 → 2.0.0

package/README.md

@@ -0,0 +1,133 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/disposable@2.0.0/packages/disposable#readme">@guanghechen/disposable</a>
+  </h1>
+  <div align="center">
+    <a href="https://www.npmjs.com/package/@guanghechen/disposable">
+      <img
+        alt="Npm Version"
+        src="https://img.shields.io/npm/v/@guanghechen/disposable.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/disposable">
+      <img
+        alt="Npm Download"
+        src="https://img.shields.io/npm/dm/@guanghechen/disposable.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/disposable">
+      <img
+        alt="Npm License"
+        src="https://img.shields.io/npm/l/@guanghechen/disposable.svg"
+      />
+    </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs, esm"
+        src="https://img.shields.io/badge/module_formats-cjs%2C%20esm-green.svg"
+      />
+    </a>
+    <a href="https://github.com/nodejs/node">
+      <img
+        alt="Node.js Version"
+        src="https://img.shields.io/node/v/@guanghechen/disposable"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Tested with Jest"
+        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
+      />
+    </a>
+    <a href="https://github.com/prettier/prettier">
+      <img
+        alt="Code Style: prettier"
+        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
+      />
+    </a>
+  </div>
+</header>
+<br/>
+
+Disposable pattern implementation for resource cleanup and memory management.
+
+## Install
+
+- npm
+
+  ```bash
+  npm install --save @guanghechen/disposable
+  ```
+
+- yarn
+
+  ```bash
+  yarn add @guanghechen/disposable
+  ```
+
+## Usage
+
+|        Name        |                        Description                        |
+| :----------------: | :-------------------------------------------------------: |
+|   `Disposable`     |     Single disposable resource with cleanup callback     |
+| `BatchDisposable`  |     Batch disposable for managing multiple resources     |
+|   `disposeAll`     |        Utility to dispose all disposable items           |
+|  `isDisposable`    |      Type guard to check if object is disposable         |
+
+## Example
+
+- Basic disposable:
+
+  ```typescript
+  import { Disposable } from '@guanghechen/disposable'
+
+  const resource = new Disposable(() => {
+    console.log('Resource cleaned up!')
+  })
+
+  console.log(resource.disposed) // false
+  resource.dispose()
+  console.log(resource.disposed) // true
+  // Output: "Resource cleaned up!"
+  ```
+
+- Batch disposable:
+
+  ```typescript
+  import { BatchDisposable, Disposable } from '@guanghechen/disposable'
+
+  const batch = new BatchDisposable()
+
+  const resource1 = new Disposable(() => console.log('Resource 1 disposed'))
+  const resource2 = new Disposable(() => console.log('Resource 2 disposed'))
+
+  batch.registerDisposable(resource1)
+  batch.registerDisposable(resource2)
+
+  batch.dispose()
+  // Output: "Resource 1 disposed"
+  // Output: "Resource 2 disposed"
+  ```
+
+- Utility functions:
+
+  ```typescript
+  import { disposeAll, isDisposable } from '@guanghechen/disposable'
+
+  const items = [
+    new Disposable(() => console.log('Disposed 1')),
+    new Disposable(() => console.log('Disposed 2')),
+    'not disposable'
+  ]
+
+  items.forEach(item => {
+    if (isDisposable(item)) {
+      console.log('Item is disposable')
+    }
+  })
+
+  disposeAll(items) // Disposes all disposable items in the array
+  ```
+
+[homepage]:
+  https://github.com/guanghechen/sora/tree/@guanghechen/disposable@2.0.0/packages/disposable#readme

package/lib/cjs/index.cjs

@@ -109,4 +109,3 @@ Object.keys(disposable_types).forEach(function (k) {
         get: function () { return disposable_types[k]; }
     });
 });
-//# sourceMappingURL=index.cjs.map

package/lib/esm/index.mjs

@@ -97,4 +97,3 @@ function isDisposable(obj) {
 }
 
 export { BatchDisposable, Disposable, SafeBatchHandler, disposeAll, isDisposable };
-//# sourceMappingURL=index.mjs.map

package/lib/types/index.d.ts

@@ -31,4 +31,3 @@ declare function disposeAll(disposables: Iterable<IDisposable>): void | never;
 declare function isDisposable(obj: unknown): obj is IDisposable;
 
 export { BatchDisposable, Disposable, SafeBatchHandler, disposeAll, isDisposable };
-//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@guanghechen/disposable",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/disposable@1.0.1",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/disposable@1.0.3",
     "directory": "packages/disposable"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/disposable@1.0.1/packages/disposable#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/disposable@1.0.3/packages/disposable#readme",
   "keywords": [
     "disposable"
   ],
@@ -25,6 +25,13 @@
   "module": "./lib/esm/index.mjs",
   "source": "./src/index.ts",
   "license": "MIT",
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -34,7 +41,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@guanghechen/disposable.types": "^1.0.2"
+    "@guanghechen/disposable.types": "^2.0.0"
   },
-  "gitHead": "4d896054ffb818e22b520d50cb4030ec09abc277"
+  "gitHead": "12990a720b31d50d217e2e17a6191256dc94eda6"
 }