@wixc3/patterns - npm Package Compare versions

Comparing version 15.1.1 to 15.2.0

dist/cjs/disposables/index.d.ts

 export * from './create-disposables';
 export * from './disposable';
 export * from './safe-disposable';
+export * from './types';
 export type { DisposableItem } from './disposables-group';
 export { DisposalGroup, GroupConstraints } from './constraints';
 //# sourceMappingURL=index.d.ts.map

dist/cjs/disposables/index.js

@@ -20,2 +20,3 @@ "use strict";
 __exportStar(require("./safe-disposable"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

dist/cjs/disposables/safe-disposable.d.ts

 import { Disposables } from '.';
-export type IDisposable = {
-    dispose: () => unknown;
-};
+import { IDisposable } from './types';
 declare const DISPOSAL_GUARD_DEFAULTS: {
@@ -64,3 +62,3 @@ name: string;
      */
-    get isDisposed(): boolean;
+    isDisposed: () => boolean;
     /**
@@ -67,0 +65,0 @@ * After disposal starts, it's necessary to avoid executing some code. `guard` is used for those cases.

dist/cjs/disposables/safe-disposable.js

@@ -6,3 +6,3 @@ "use strict";
 const promise_assist_1 = require("promise-assist");
-const DELAY_DISPOSAL = 'unreleased disposal guard - did you forget to use "using _ = this.guard()"?';
+const DELAY_DISPOSAL = 'unreleased disposal guard, an async guarded task is still running';
 const DISPOSAL_GUARD_DEFAULTS = {
@@ -48,2 +48,6 @@ name: 'unsafe execution: instance was disposed',
         this.intervals = new Set();
+        /**
+         * returns true if the disposal process started
+         */
+        this.isDisposed = () => this._isDisposed || this._isDisposing;
         this.registerGroup(DELAY_DISPOSAL, { before: 'default' });
@@ -69,3 +73,3 @@ this.add('dispose timeouts and intervals', () => {
     async dispose() {
-        if (!this.isDisposed && !this._isDisposing) {
+        if (!this.isDisposed() && !this._isDisposing) {
             this._isDisposing = true;
@@ -77,8 +81,2 @@ await super.dispose();
     }
-    /**
-     * returns true if the disposal process started
-     */
-    get isDisposed() {
-        return this._isDisposed || this._isDisposing;
-    }
     // guard<T>(options?: OPTIONS): { [Symbol.dispose]: () => void };
@@ -88,3 +86,3 @@ // @internal
         const { fn, options: { name, timeout, usedWhileDisposing }, } = extractArgs(fnOrOptions, options);
-        if (this.isDisposed && !(this._isDisposing && usedWhileDisposing)) {
+        if (this.isDisposed() && !(this._isDisposing && usedWhileDisposing)) {
             throw new Error('Instance was disposed');
@@ -112,12 +110,11 @@ }
     setTimeout(fn, timeout) {
-        return this.guard(() => {
-            const handle = setTimeout(() => {
-                this.timeouts.delete(handle);
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, timeout);
-            this.timeouts.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setTimeout(() => {
+            this.timeouts.delete(handle);
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, timeout);
+        this.timeouts.add(handle);
+        return handle;
     }
@@ -129,11 +126,10 @@ /**
     setInterval(fn, interval) {
-        return this.guard(() => {
-            const handle = setInterval(() => {
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, interval);
-            this.intervals.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setInterval(() => {
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, interval);
+        this.intervals.add(handle);
+        return handle;
     }
@@ -140,0 +136,0 @@ }

dist/esm/disposables/index.d.ts

 export * from './create-disposables';
 export * from './disposable';
 export * from './safe-disposable';
+export * from './types';
 export type { DisposableItem } from './disposables-group';
 export { DisposalGroup, GroupConstraints } from './constraints';
 //# sourceMappingURL=index.d.ts.map

dist/esm/disposables/index.js

 export * from './create-disposables';
 export * from './disposable';
 export * from './safe-disposable';
+export * from './types';
 //# sourceMappingURL=index.js.map

dist/esm/disposables/safe-disposable.d.ts

 import { Disposables } from '.';
-export type IDisposable = {
-    dispose: () => unknown;
-};
+import { IDisposable } from './types';
 declare const DISPOSAL_GUARD_DEFAULTS: {
@@ -64,3 +62,3 @@ name: string;
      */
-    get isDisposed(): boolean;
+    isDisposed: () => boolean;
     /**
@@ -67,0 +65,0 @@ * After disposal starts, it's necessary to avoid executing some code. `guard` is used for those cases.

dist/esm/disposables/safe-disposable.js

 import { Disposables } from '.';
 import { deferred } from 'promise-assist';
-const DELAY_DISPOSAL = 'unreleased disposal guard - did you forget to use "using _ = this.guard()"?';
+const DELAY_DISPOSAL = 'unreleased disposal guard, an async guarded task is still running';
 const DISPOSAL_GUARD_DEFAULTS = {
@@ -44,2 +44,6 @@ name: 'unsafe execution: instance was disposed',
         this.intervals = new Set();
+        /**
+         * returns true if the disposal process started
+         */
+        this.isDisposed = () => this._isDisposed || this._isDisposing;
         this.registerGroup(DELAY_DISPOSAL, { before: 'default' });
@@ -65,3 +69,3 @@ this.add('dispose timeouts and intervals', () => {
     async dispose() {
-        if (!this.isDisposed && !this._isDisposing) {
+        if (!this.isDisposed() && !this._isDisposing) {
             this._isDisposing = true;
@@ -73,8 +77,2 @@ await super.dispose();
     }
-    /**
-     * returns true if the disposal process started
-     */
-    get isDisposed() {
-        return this._isDisposed || this._isDisposing;
-    }
     // guard<T>(options?: OPTIONS): { [Symbol.dispose]: () => void };
@@ -84,3 +82,3 @@ // @internal
         const { fn, options: { name, timeout, usedWhileDisposing }, } = extractArgs(fnOrOptions, options);
-        if (this.isDisposed && !(this._isDisposing && usedWhileDisposing)) {
+        if (this.isDisposed() && !(this._isDisposing && usedWhileDisposing)) {
             throw new Error('Instance was disposed');
@@ -108,12 +106,11 @@ }
     setTimeout(fn, timeout) {
-        return this.guard(() => {
-            const handle = setTimeout(() => {
-                this.timeouts.delete(handle);
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, timeout);
-            this.timeouts.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setTimeout(() => {
+            this.timeouts.delete(handle);
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, timeout);
+        this.timeouts.add(handle);
+        return handle;
     }
@@ -125,11 +122,10 @@ /**
     setInterval(fn, interval) {
-        return this.guard(() => {
-            const handle = setInterval(() => {
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, interval);
-            this.intervals.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setInterval(() => {
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, interval);
+        this.intervals.add(handle);
+        return handle;
     }
@@ -136,0 +132,0 @@ }

package.json

 {
   "name": "@wixc3/patterns",
-  "version": "15.1.1",
+  "version": "15.2.0",
   "description": "A utility for saving objects to be disposed",
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.js",

src/disposables/index.ts

 export * from './create-disposables';
 export * from './disposable';
 export * from './safe-disposable';
+export * from './types';
 export type { DisposableItem } from './disposables-group';
 export { DisposalGroup, GroupConstraints } from './constraints';

src/disposables/safe-disposable.ts

 import { Disposables } from '.';
 import { deferred } from 'promise-assist';
+import { IDisposable } from './types';
 
-export type IDisposable = {
-    dispose: () => unknown;
-};
-
-const DELAY_DISPOSAL = 'unreleased disposal guard - did you forget to use "using _ = this.guard()"?';
+const DELAY_DISPOSAL = 'unreleased disposal guard, an async guarded task is still running';
 const DISPOSAL_GUARD_DEFAULTS = {
@@ -76,3 +73,3 @@ name: 'unsafe execution: instance was disposed',
     override async dispose() {
-        if (!this.isDisposed && !this._isDisposing) {
+        if (!this.isDisposed() && !this._isDisposing) {
             this._isDisposing = true;
@@ -88,5 +85,3 @@ await super.dispose();
      */
-    get isDisposed(): boolean {
-        return this._isDisposed || this._isDisposing;
-    }
+    isDisposed = () => this._isDisposed || this._isDisposing;
 
@@ -125,3 +120,3 @@ /**
 
-        if (this.isDisposed && !(this._isDisposing && usedWhileDisposing)) {
+        if (this.isDisposed() && !(this._isDisposing && usedWhileDisposing)) {
             throw new Error('Instance was disposed');
@@ -152,12 +147,11 @@ }
     setTimeout(fn: () => void, timeout: number): ReturnType<typeof setTimeout> {
-        return this.guard(() => {
-            const handle = setTimeout(() => {
-                this.timeouts.delete(handle);
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, timeout);
-            this.timeouts.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setTimeout(() => {
+            this.timeouts.delete(handle);
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, timeout);
+        this.timeouts.add(handle);
+        return handle;
     }
@@ -170,11 +164,10 @@
     setInterval(fn: () => void, interval: number): ReturnType<typeof setInterval> {
-        return this.guard(() => {
-            const handle = setInterval(() => {
-                if (!this.isDisposed) {
-                    fn();
-                }
-            }, interval);
-            this.intervals.add(handle);
-            return handle;
-        });
+        this.guard();
+        const handle = setInterval(() => {
+            if (!this.isDisposed()) {
+                fn();
+            }
+        }, interval);
+        this.intervals.add(handle);
+        return handle;
     }
@@ -181,0 +174,0 @@

src/test/safe-disposable.unit.ts

@@ -9,5 +9,5 @@ import { expect } from 'chai';
             const disposable = new SafeDisposable('test');
-            expect(disposable.isDisposed).to.be.false;
+            expect(disposable.isDisposed()).to.be.false;
             await disposable.dispose();
-            expect(disposable.isDisposed).to.be.true;
+            expect(disposable.isDisposed()).to.be.true;
         });
@@ -101,3 +101,3 @@ it('executes inner disposal functions', async () => {
                     disposable.guard(() => 'guarded return value'),
-                    'guard return value',
+                    'guard return value'
                 ).to.eql('guarded return value');
@@ -122,3 +122,3 @@ const disposing = disposable.dispose();
 
-                    expect(disposables.isDisposed, 'isDisposed').to.be.true;
+                    expect(disposables.isDisposed(), 'isDisposed').to.be.true;
                     expect(disposeCalled, 'disposeCalled').to.be.false;
@@ -125,0 +125,0 @@ return 'guarded return value';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

258380

increased by0.53%

Number of package files

130

increased by7.44%

Lines of code

4992

increased by0.4%

No dependency changes