@furystack/utils 7.0.1 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -36
- package/README.md +9 -9
- package/esm/debounce.d.ts.map +1 -1
- package/esm/deep-merge.d.ts.map +1 -1
- package/esm/deep-merge.spec.js +1 -1
- package/esm/deep-merge.spec.js.map +1 -1
- package/esm/event-hub.d.ts +1 -2
- package/esm/event-hub.d.ts.map +1 -1
- package/esm/event-hub.js +2 -2
- package/esm/event-hub.js.map +1 -1
- package/esm/event-hub.spec.js +4 -4
- package/esm/event-hub.spec.js.map +1 -1
- package/esm/index.d.ts +6 -4
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +6 -4
- package/esm/index.js.map +1 -1
- package/esm/is-async-disposable.d.ts +7 -0
- package/esm/is-async-disposable.d.ts.map +1 -0
- package/esm/is-async-disposable.js +9 -0
- package/esm/is-async-disposable.js.map +1 -0
- package/esm/is-async-disposable.spec.d.ts +2 -0
- package/esm/is-async-disposable.spec.d.ts.map +1 -0
- package/esm/is-async-disposable.spec.js +21 -0
- package/esm/is-async-disposable.spec.js.map +1 -0
- package/esm/is-disposable.d.ts +7 -0
- package/esm/is-disposable.d.ts.map +1 -0
- package/esm/is-disposable.js +9 -0
- package/esm/is-disposable.js.map +1 -0
- package/esm/is-disposable.spec.d.ts +2 -0
- package/esm/is-disposable.spec.d.ts.map +1 -0
- package/esm/is-disposable.spec.js +21 -0
- package/esm/is-disposable.spec.js.map +1 -0
- package/esm/observable-value.d.ts +4 -5
- package/esm/observable-value.d.ts.map +1 -1
- package/esm/observable-value.js +3 -3
- package/esm/observable-value.js.map +1 -1
- package/esm/observable-value.spec.d.ts.map +1 -1
- package/esm/observable-value.spec.js +10 -9
- package/esm/observable-value.spec.js.map +1 -1
- package/esm/path-helper.js +1 -1
- package/esm/path-helper.js.map +1 -1
- package/esm/path-helper.spec.d.ts.map +1 -1
- package/esm/path-helper.spec.js +9 -1
- package/esm/path-helper.spec.js.map +1 -1
- package/esm/sort-by.d.ts +1 -1
- package/esm/sort-by.d.ts.map +1 -1
- package/esm/tuple.d.ts.map +1 -1
- package/esm/using-async.d.ts +8 -0
- package/esm/using-async.d.ts.map +1 -0
- package/esm/using-async.js +22 -0
- package/esm/using-async.js.map +1 -0
- package/esm/using-async.spec.d.ts +17 -0
- package/esm/using-async.spec.d.ts.map +1 -0
- package/esm/using-async.spec.js +84 -0
- package/esm/using-async.spec.js.map +1 -0
- package/esm/using.d.ts +8 -0
- package/esm/using.d.ts.map +1 -0
- package/esm/using.js +15 -0
- package/esm/using.js.map +1 -0
- package/esm/{disposable.spec.d.ts → using.spec.d.ts} +2 -7
- package/esm/using.spec.d.ts.map +1 -0
- package/esm/using.spec.js +62 -0
- package/esm/using.spec.js.map +1 -0
- package/esm/value-observer.d.ts +3 -4
- package/esm/value-observer.d.ts.map +1 -1
- package/esm/value-observer.js +3 -3
- package/esm/value-observer.js.map +1 -1
- package/package.json +3 -3
- package/src/deep-merge.spec.ts +2 -2
- package/src/event-hub.spec.ts +4 -4
- package/src/event-hub.ts +2 -4
- package/src/index.ts +6 -4
- package/src/is-async-disposable.spec.ts +23 -0
- package/src/is-async-disposable.ts +8 -0
- package/src/is-disposable.spec.ts +23 -0
- package/src/is-disposable.ts +8 -0
- package/src/observable-value.spec.ts +11 -9
- package/src/observable-value.ts +3 -4
- package/src/path-helper.spec.ts +10 -1
- package/src/path-helper.ts +1 -1
- package/src/using-async.spec.ts +93 -0
- package/src/using-async.ts +24 -0
- package/src/using.spec.ts +67 -0
- package/src/using.ts +13 -0
- package/src/value-observer.ts +3 -4
- package/esm/disposable.d.ts +0 -49
- package/esm/disposable.d.ts.map +0 -1
- package/esm/disposable.js +0 -56
- package/esm/disposable.js.map +0 -1
- package/esm/disposable.spec.d.ts.map +0 -1
- package/esm/disposable.spec.js +0 -118
- package/esm/disposable.spec.js.map +0 -1
- package/esm/trace.d.ts +0 -119
- package/esm/trace.d.ts.map +0 -1
- package/esm/trace.js +0 -139
- package/esm/trace.js.map +0 -1
- package/esm/trace.spec.d.ts +0 -2
- package/esm/trace.spec.d.ts.map +0 -1
- package/esm/trace.spec.js +0 -184
- package/esm/trace.spec.js.map +0 -1
- package/src/disposable.spec.ts +0 -130
- package/src/disposable.ts +0 -69
- package/src/trace.spec.ts +0 -200
- package/src/trace.ts +0 -265
package/esm/path-helper.js
CHANGED
|
@@ -33,7 +33,7 @@ export class PathHelper {
|
|
|
33
33
|
* @returns the joined path string
|
|
34
34
|
*/
|
|
35
35
|
static joinPaths(...args) {
|
|
36
|
-
return args.map(this.trimSlashes).join('/');
|
|
36
|
+
return args.map((path) => this.trimSlashes(path)).join('/');
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
39
|
* Checks if the ancestorPath is really the ancestor of the descendantPath
|
package/esm/path-helper.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"path-helper.js","sourceRoot":"","sources":["../src/path-helper.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACrB;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACvC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,GAAG,IAAc;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;
|
|
1
|
+
{"version":3,"file":"path-helper.js","sourceRoot":"","sources":["../src/path-helper.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACrB;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACvC,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACvE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,GAAG,IAAc;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,YAAoB,EAAE,cAAsB;QACrE,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACzE,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa,CAAC,IAAY;QACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,QAAQ,CAAC,GAAG,EAAE,CAAA;QAChB,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAC3B,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,IAAY;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzC,CAAC;CACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"path-helper.spec.d.ts","sourceRoot":"","sources":["../src/path-helper.spec.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,eAAe,
|
|
1
|
+
{"version":3,"file":"path-helper.spec.d.ts","sourceRoot":"","sources":["../src/path-helper.spec.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,eAAe,qCA0E1B,CAAA"}
|
package/esm/path-helper.spec.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { describe,
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
2
|
import { PathHelper } from './path-helper.js';
|
|
3
3
|
/**
|
|
4
4
|
* Path Helper tests
|
|
@@ -56,5 +56,13 @@ export const pathHelperTests = describe('PathHelper', () => {
|
|
|
56
56
|
expect(PathHelper.getParentPath('Root')).toBe('Root');
|
|
57
57
|
});
|
|
58
58
|
});
|
|
59
|
+
describe('#normalize()', () => {
|
|
60
|
+
it('Should normalize the path', () => {
|
|
61
|
+
expect(PathHelper.normalize('Root/Example/Content')).toBe('Root/Example/Content');
|
|
62
|
+
expect(PathHelper.normalize('/Root/Example/Content')).toBe('Root/Example/Content');
|
|
63
|
+
expect(PathHelper.normalize('Root/Example/Content/')).toBe('Root/Example/Content');
|
|
64
|
+
expect(PathHelper.normalize('/Root/Example/Content/')).toBe('Root/Example/Content');
|
|
65
|
+
});
|
|
66
|
+
});
|
|
59
67
|
});
|
|
60
68
|
//# sourceMappingURL=path-helper.spec.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"path-helper.spec.js","sourceRoot":"","sources":["../src/path-helper.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,
|
|
1
|
+
{"version":3,"file":"path-helper.spec.js","sourceRoot":"","sources":["../src/path-helper.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IACzD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjE,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC5D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC9D,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;YAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;YAChE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;YACjE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,eAAe,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtF,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,eAAe,EAAE,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACxF,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAA;QAC1G,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACvD,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;YACjF,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;YAClF,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;YAClF,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
package/esm/sort-by.d.ts
CHANGED
|
@@ -9,5 +9,5 @@ declare global {
|
|
|
9
9
|
sortBy: (field: keyof T, direction?: 'asc' | 'desc') => T[];
|
|
10
10
|
}
|
|
11
11
|
}
|
|
12
|
-
export declare const compareBy: <T, K extends keyof T>(entity1: T, entity2: T, field: K, direction:
|
|
12
|
+
export declare const compareBy: <T, K extends keyof T>(entity1: T, entity2: T, field: K, direction: "asc" | "desc") => 1 | 0 | -1;
|
|
13
13
|
//# sourceMappingURL=sort-by.d.ts.map
|
package/esm/sort-by.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sort-by.d.ts","sourceRoot":"","sources":["../src/sort-by.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,WAAW,KAAK,CAAC,CAAC;QACtB;;WAEG;QACH,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,KAAK,CAAC,EAAE,CAAA;KAC5D;CACF;AAED,eAAO,MAAM,SAAS,
|
|
1
|
+
{"version":3,"file":"sort-by.d.ts","sourceRoot":"","sources":["../src/sort-by.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,WAAW,KAAK,CAAC,CAAC;QACtB;;WAEG;QACH,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,KAAK,CAAC,EAAE,CAAA;KAC5D;CACF;AAED,eAAO,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,SAAS,CAAC,aAAa,KAAK,GAAG,MAAM,eAU1G,CAAA"}
|
package/esm/tuple.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,KAAK,
|
|
1
|
+
{"version":3,"file":"tuple.d.ts","sourceRoot":"","sources":["../src/tuple.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS,MAAM,EAAE,WAAW,CAAC,MAAS,CAAA"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method that accepts an IDisposable resource that will be disposed after the callback
|
|
3
|
+
* @param resource The resource that is used in the callback and will be disposed afterwards
|
|
4
|
+
* @param callback The callback that will be executed asynchrounously before the resource will be disposed
|
|
5
|
+
* @returns A promise that will be resolved with a return value after the resource is disposed
|
|
6
|
+
*/
|
|
7
|
+
export declare const usingAsync: <T extends Disposable | AsyncDisposable, TReturns>(resource: T, callback: (r: T) => Promise<TReturns>) => Promise<TReturns>;
|
|
8
|
+
//# sourceMappingURL=using-async.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using-async.d.ts","sourceRoot":"","sources":["../src/using-async.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAU,CAAC,SAAS,UAAU,GAAG,eAAe,EAAE,QAAQ,YACrE,CAAC,YACD,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,QAAQ,CAAC,sBAYtC,CAAA"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { isAsyncDisposable } from './is-async-disposable.js';
|
|
2
|
+
import { isDisposable } from './is-disposable.js';
|
|
3
|
+
/**
|
|
4
|
+
* Method that accepts an IDisposable resource that will be disposed after the callback
|
|
5
|
+
* @param resource The resource that is used in the callback and will be disposed afterwards
|
|
6
|
+
* @param callback The callback that will be executed asynchrounously before the resource will be disposed
|
|
7
|
+
* @returns A promise that will be resolved with a return value after the resource is disposed
|
|
8
|
+
*/
|
|
9
|
+
export const usingAsync = async (resource, callback) => {
|
|
10
|
+
try {
|
|
11
|
+
return await callback(resource);
|
|
12
|
+
}
|
|
13
|
+
finally {
|
|
14
|
+
if (isAsyncDisposable(resource)) {
|
|
15
|
+
await resource[Symbol.asyncDispose]();
|
|
16
|
+
}
|
|
17
|
+
if (isDisposable(resource)) {
|
|
18
|
+
resource[Symbol.dispose]();
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=using-async.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using-async.js","sourceRoot":"","sources":["../src/using-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,QAAW,EACX,QAAqC,EACrC,EAAE;IACF,IAAI,CAAC;QACH,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACjC,CAAC;YAAS,CAAC;QACT,IAAI,iBAAiB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,MAAM,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAA;QACvC,CAAC;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAA;QAC5B,CAAC;IACH,CAAC;AACH,CAAC,CAAA"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare class MockAsyncDisposable implements AsyncDisposable {
|
|
2
|
+
private disposed;
|
|
3
|
+
isDisposed: () => boolean;
|
|
4
|
+
/**
|
|
5
|
+
* Disposes the MockDisposable instance, calls the dispose callback
|
|
6
|
+
*/
|
|
7
|
+
[Symbol.asyncDispose](): Promise<void>;
|
|
8
|
+
/**
|
|
9
|
+
* Mock to throw an error
|
|
10
|
+
*/
|
|
11
|
+
whooops(): void;
|
|
12
|
+
/**
|
|
13
|
+
* Defines the callback that will be called on dispose
|
|
14
|
+
*/
|
|
15
|
+
disposeCallback: () => void;
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=using-async.spec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using-async.spec.d.ts","sourceRoot":"","sources":["../src/using-async.spec.ts"],"names":[],"mappings":"AAIA,qBAAa,mBAAoB,YAAW,eAAe;IACzD,OAAO,CAAC,QAAQ,CAAQ;IACjB,UAAU,gBAAsB;IACvC;;OAEG;IACU,CAAC,MAAM,CAAC,YAAY,CAAC;IAKlC;;OAEG;IACI,OAAO;IAId;;OAEG;IACI,eAAe,EAAG,MAAM,IAAI,CAAA;CACpC"}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { usingAsync } from './using-async.js';
|
|
3
|
+
import { MockDisposable } from './using.spec.js';
|
|
4
|
+
export class MockAsyncDisposable {
|
|
5
|
+
disposed = false;
|
|
6
|
+
isDisposed = () => this.disposed;
|
|
7
|
+
/**
|
|
8
|
+
* Disposes the MockDisposable instance, calls the dispose callback
|
|
9
|
+
*/
|
|
10
|
+
async [Symbol.asyncDispose]() {
|
|
11
|
+
this.disposed = true;
|
|
12
|
+
this.disposeCallback && this.disposeCallback();
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Mock to throw an error
|
|
16
|
+
*/
|
|
17
|
+
whooops() {
|
|
18
|
+
throw Error('Whooops');
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Defines the callback that will be called on dispose
|
|
22
|
+
*/
|
|
23
|
+
disposeCallback;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Unit tests for disposables
|
|
27
|
+
*/
|
|
28
|
+
describe('usingAsync()', () => {
|
|
29
|
+
it('dispose should be called with usingAsync()', async () => {
|
|
30
|
+
const callbackMethod = vi.fn();
|
|
31
|
+
await usingAsync(new MockAsyncDisposable(), async (d) => {
|
|
32
|
+
d.disposeCallback = () => {
|
|
33
|
+
callbackMethod();
|
|
34
|
+
};
|
|
35
|
+
return new Promise((resolve) => {
|
|
36
|
+
setTimeout(resolve, 1);
|
|
37
|
+
});
|
|
38
|
+
});
|
|
39
|
+
expect(callbackMethod).toBeCalled();
|
|
40
|
+
});
|
|
41
|
+
it('dispose should be called when async fails', async () => {
|
|
42
|
+
const callbackMethod = vi.fn();
|
|
43
|
+
try {
|
|
44
|
+
await usingAsync(new MockAsyncDisposable(), async (d) => {
|
|
45
|
+
d.disposeCallback = () => {
|
|
46
|
+
callbackMethod();
|
|
47
|
+
};
|
|
48
|
+
return new Promise((_resolve, reject) => {
|
|
49
|
+
setTimeout(reject, 1);
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
}
|
|
53
|
+
catch (error) {
|
|
54
|
+
/** ignore */
|
|
55
|
+
}
|
|
56
|
+
expect(callbackMethod).toBeCalled();
|
|
57
|
+
});
|
|
58
|
+
it('should await dispose for asyncs with usingAsync()', async () => {
|
|
59
|
+
class AsyncDispose {
|
|
60
|
+
/** flag */
|
|
61
|
+
isDisposed = false;
|
|
62
|
+
/** set isDisposed with a timeout */
|
|
63
|
+
async [Symbol.asyncDispose]() {
|
|
64
|
+
await new Promise((resolve) => setTimeout(() => {
|
|
65
|
+
this.isDisposed = true;
|
|
66
|
+
resolve();
|
|
67
|
+
}, 10));
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
const asyncDispose = new AsyncDispose();
|
|
71
|
+
await usingAsync(asyncDispose, async () => {
|
|
72
|
+
/** */
|
|
73
|
+
});
|
|
74
|
+
expect(asyncDispose.isDisposed).toBe(true);
|
|
75
|
+
});
|
|
76
|
+
it('Should dispose a non-async disposable object as well', async () => {
|
|
77
|
+
const createdResource = await usingAsync(new MockDisposable(), async (mock) => {
|
|
78
|
+
expect(mock).toBeInstanceOf(MockDisposable);
|
|
79
|
+
return mock;
|
|
80
|
+
});
|
|
81
|
+
expect(createdResource.isDisposed()).toBe(true);
|
|
82
|
+
});
|
|
83
|
+
});
|
|
84
|
+
//# sourceMappingURL=using-async.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using-async.spec.js","sourceRoot":"","sources":["../src/using-async.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,OAAO,mBAAmB;IACtB,QAAQ,GAAG,KAAK,CAAA;IACjB,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAA;IACvC;;OAEG;IACI,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,EAAE,CAAA;IAChD,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACxB,CAAC;IAED;;OAEG;IACI,eAAe,CAAa;CACpC;AAED;;GAEG;AACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QAC9B,MAAM,UAAU,CAAC,IAAI,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;YACtD,CAAC,CAAC,eAAe,GAAG,GAAG,EAAE;gBACvB,cAAc,EAAE,CAAA;YAClB,CAAC,CAAA;YACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC7B,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;YACxB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QAC9B,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,IAAI,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;gBACtD,CAAC,CAAC,eAAe,GAAG,GAAG,EAAE;oBACvB,cAAc,EAAE,CAAA;gBAClB,CAAC,CAAA;gBACD,OAAO,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;oBACtC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;gBACvB,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa;QACf,CAAC;QACD,MAAM,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,YAAY;YAChB,WAAW;YACJ,UAAU,GAAG,KAAK,CAAA;YACzB,oCAAoC;YAC7B,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC;gBAChC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAClC,UAAU,CAAC,GAAG,EAAE;oBACd,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;oBACtB,OAAO,EAAE,CAAA;gBACX,CAAC,EAAE,EAAE,CAAC,CACP,CAAA;YACH,CAAC;SACF;QAED,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAA;QACvC,MAAM,UAAU,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM;QACR,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5C,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,eAAe,GAAG,MAAM,UAAU,CAAC,IAAI,cAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC5E,MAAM,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;YAC3C,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACjD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
package/esm/using.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method that accepts an IDisposable resource that will be disposed after the callback
|
|
3
|
+
* @param resource The resource that is used in the callback and will be disposed afterwards
|
|
4
|
+
* @param callback The callback that will be executed synchrounously before the resource will be disposed
|
|
5
|
+
* @returns the value that will be returned by the callback method
|
|
6
|
+
*/
|
|
7
|
+
export declare const using: <T extends Disposable, TReturns>(resource: T, callback: (r: T) => TReturns) => TReturns;
|
|
8
|
+
//# sourceMappingURL=using.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using.d.ts","sourceRoot":"","sources":["../src/using.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS,UAAU,EAAE,QAAQ,YAAY,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,KAAK,QAAQ,aAM9F,CAAA"}
|
package/esm/using.js
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Method that accepts an IDisposable resource that will be disposed after the callback
|
|
3
|
+
* @param resource The resource that is used in the callback and will be disposed afterwards
|
|
4
|
+
* @param callback The callback that will be executed synchrounously before the resource will be disposed
|
|
5
|
+
* @returns the value that will be returned by the callback method
|
|
6
|
+
*/
|
|
7
|
+
export const using = (resource, callback) => {
|
|
8
|
+
try {
|
|
9
|
+
return callback(resource);
|
|
10
|
+
}
|
|
11
|
+
finally {
|
|
12
|
+
resource[Symbol.dispose]();
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
//# sourceMappingURL=using.js.map
|
package/esm/using.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using.js","sourceRoot":"","sources":["../src/using.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAiC,QAAW,EAAE,QAA4B,EAAE,EAAE;IACjG,IAAI,CAAC;QACH,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAA;IAC3B,CAAC;YAAS,CAAC;QACT,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAA;IAC5B,CAAC;AACH,CAAC,CAAA"}
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import type { Disposable } from './disposable.js';
|
|
2
1
|
export declare class MockDisposable implements Disposable {
|
|
3
2
|
private disposed;
|
|
4
3
|
isDisposed: () => boolean;
|
|
5
4
|
/**
|
|
6
5
|
* Disposes the MockDisposable instance, calls the dispose callback
|
|
7
6
|
*/
|
|
8
|
-
dispose
|
|
7
|
+
[Symbol.dispose](): void;
|
|
9
8
|
/**
|
|
10
9
|
* Mock to throw an error
|
|
11
10
|
*/
|
|
@@ -15,8 +14,4 @@ export declare class MockDisposable implements Disposable {
|
|
|
15
14
|
*/
|
|
16
15
|
disposeCallback: () => void;
|
|
17
16
|
}
|
|
18
|
-
|
|
19
|
-
* Unit tests for disposables
|
|
20
|
-
*/
|
|
21
|
-
export declare const disposableTests: import("vitest").SuiteCollector<{}>;
|
|
22
|
-
//# sourceMappingURL=disposable.spec.d.ts.map
|
|
17
|
+
//# sourceMappingURL=using.spec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using.spec.d.ts","sourceRoot":"","sources":["../src/using.spec.ts"],"names":[],"mappings":"AAGA,qBAAa,cAAe,YAAW,UAAU;IAC/C,OAAO,CAAC,QAAQ,CAAQ;IACjB,UAAU,gBAAsB;IACvC;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;IAKvB;;OAEG;IACI,OAAO;IAId;;OAEG;IACI,eAAe,EAAG,MAAM,IAAI,CAAA;CACpC"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import { describe, expect, it, vi } from 'vitest';
|
|
2
|
+
import { using } from './using.js';
|
|
3
|
+
export class MockDisposable {
|
|
4
|
+
disposed = false;
|
|
5
|
+
isDisposed = () => this.disposed;
|
|
6
|
+
/**
|
|
7
|
+
* Disposes the MockDisposable instance, calls the dispose callback
|
|
8
|
+
*/
|
|
9
|
+
[Symbol.dispose]() {
|
|
10
|
+
this.disposed = true;
|
|
11
|
+
this.disposeCallback && this.disposeCallback();
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Mock to throw an error
|
|
15
|
+
*/
|
|
16
|
+
whooops() {
|
|
17
|
+
throw Error('Whooops');
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Defines the callback that will be called on dispose
|
|
21
|
+
*/
|
|
22
|
+
disposeCallback;
|
|
23
|
+
}
|
|
24
|
+
describe('Using', () => {
|
|
25
|
+
it('Can be constructed', () => {
|
|
26
|
+
using(new MockDisposable(), (d) => {
|
|
27
|
+
expect(d).toBeInstanceOf(MockDisposable);
|
|
28
|
+
});
|
|
29
|
+
});
|
|
30
|
+
it('Should return a value from a callback', () => {
|
|
31
|
+
const returned = using(new MockDisposable(), () => {
|
|
32
|
+
return 1;
|
|
33
|
+
});
|
|
34
|
+
expect(returned).toBe(1);
|
|
35
|
+
});
|
|
36
|
+
describe('isDisposed', () => {
|
|
37
|
+
it('should return a correct value before and after disposition', () => {
|
|
38
|
+
const d = new MockDisposable();
|
|
39
|
+
expect(d.isDisposed()).toBe(false);
|
|
40
|
+
d[Symbol.dispose]();
|
|
41
|
+
expect(d.isDisposed()).toBe(true);
|
|
42
|
+
});
|
|
43
|
+
});
|
|
44
|
+
describe('dispose()', () => {
|
|
45
|
+
it('should be called on error', () => {
|
|
46
|
+
const callbackMethod = vi.fn();
|
|
47
|
+
try {
|
|
48
|
+
using(new MockDisposable(), (d) => {
|
|
49
|
+
d.disposeCallback = () => {
|
|
50
|
+
callbackMethod();
|
|
51
|
+
};
|
|
52
|
+
d.whooops();
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
catch {
|
|
56
|
+
/** ignore */
|
|
57
|
+
}
|
|
58
|
+
expect(callbackMethod).toBeCalled();
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
});
|
|
62
|
+
//# sourceMappingURL=using.spec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"using.spec.js","sourceRoot":"","sources":["../src/using.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAElC,MAAM,OAAO,cAAc;IACjB,QAAQ,GAAG,KAAK,CAAA;IACjB,UAAU,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAA;IACvC;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,EAAE,CAAA;IAChD,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,KAAK,CAAC,SAAS,CAAC,CAAA;IACxB,CAAC;IAED;;OAEG;IACI,eAAe,CAAa;CACpC;AAED,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC5B,KAAK,CAAC,IAAI,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE;YAChC,MAAM,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,cAAc,EAAE,EAAE,GAAG,EAAE;YAChD,OAAO,CAAC,CAAA;QACV,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,CAAC,GAAG,IAAI,cAAc,EAAE,CAAA;YAC9B,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAClC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAA;YACnB,MAAM,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,cAAc,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YAC9B,IAAI,CAAC;gBACH,KAAK,CAAC,IAAI,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE;oBAChC,CAAC,CAAC,eAAe,GAAG,GAAG,EAAE;wBACvB,cAAc,EAAE,CAAA;oBAClB,CAAC,CAAA;oBACD,CAAC,CAAC,OAAO,EAAE,CAAA;gBACb,CAAC,CAAC,CAAA;YACJ,CAAC;YAAC,MAAM,CAAC;gBACP,aAAa;YACf,CAAC;YACD,MAAM,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
|
package/esm/value-observer.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { Disposable } from './disposable.js';
|
|
2
1
|
import type { ObservableValue, ValueChangeCallback } from './observable-value.js';
|
|
3
2
|
export type ValueObserverOptions<T> = {
|
|
4
3
|
filter?: (nextValue: T, lastValue: T) => boolean;
|
|
@@ -19,9 +18,9 @@ export type ValueObserverOptions<T> = {
|
|
|
19
18
|
* // To update the value
|
|
20
19
|
* observableValue.setValue(Math.random());
|
|
21
20
|
* // if you want to dispose a single observer
|
|
22
|
-
* observer.dispose();
|
|
21
|
+
* observer[Symbol.dispose]();
|
|
23
22
|
* // if you want to dispose the whole observableValue with all of its observers:
|
|
24
|
-
* observableValue.dispose();
|
|
23
|
+
* observableValue[Symbol.dispose]();
|
|
25
24
|
* ```
|
|
26
25
|
* @param T This type parameter is the value type to observe
|
|
27
26
|
*/
|
|
@@ -32,7 +31,7 @@ export declare class ValueObserver<T> implements Disposable {
|
|
|
32
31
|
/**
|
|
33
32
|
* Disposes the ValueObserver instance. Unsubscribes from the observable
|
|
34
33
|
*/
|
|
35
|
-
dispose(): void;
|
|
34
|
+
[Symbol.dispose](): void;
|
|
36
35
|
/**
|
|
37
36
|
* @constructs ValueObserver<T> the ValueObserver instance
|
|
38
37
|
* @param observable The related Observable object
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"value-observer.d.ts","sourceRoot":"","sources":["../src/value-observer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"value-observer.d.ts","sourceRoot":"","sources":["../src/value-observer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAEjF,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,KAAK,OAAO,CAAA;CACjD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,UAAU;aAe/B,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;IACvC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC;aACvB,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAhBnD;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;IAIvB;;;;;OAKG;gBAEe,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,EACvC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,EACvB,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,YAAA;CAEpD"}
|
package/esm/value-observer.js
CHANGED
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
* // To update the value
|
|
15
15
|
* observableValue.setValue(Math.random());
|
|
16
16
|
* // if you want to dispose a single observer
|
|
17
|
-
* observer.dispose();
|
|
17
|
+
* observer[Symbol.dispose]();
|
|
18
18
|
* // if you want to dispose the whole observableValue with all of its observers:
|
|
19
|
-
* observableValue.dispose();
|
|
19
|
+
* observableValue[Symbol.dispose]();
|
|
20
20
|
* ```
|
|
21
21
|
* @param T This type parameter is the value type to observe
|
|
22
22
|
*/
|
|
@@ -27,7 +27,7 @@ export class ValueObserver {
|
|
|
27
27
|
/**
|
|
28
28
|
* Disposes the ValueObserver instance. Unsubscribes from the observable
|
|
29
29
|
*/
|
|
30
|
-
dispose() {
|
|
30
|
+
[Symbol.dispose]() {
|
|
31
31
|
this.observable.unsubscribe(this);
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"value-observer.js","sourceRoot":"","sources":["../src/value-observer.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"value-observer.js","sourceRoot":"","sources":["../src/value-observer.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,aAAa;IAeN;IACT;IACS;IAhBlB;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,YACkB,UAA8B,EACvC,QAAgC,EACvB,OAAiC;QAFjC,eAAU,GAAV,UAAU,CAAoB;QACvC,aAAQ,GAAR,QAAQ,CAAwB;QACvB,YAAO,GAAP,OAAO,CAA0B;IAChD,CAAC;CACL"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@furystack/utils",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "8.0.0",
|
|
4
4
|
"description": "General utilities",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
},
|
|
35
35
|
"homepage": "https://github.com/furystack/furystack",
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"typescript": "^5.
|
|
38
|
-
"vitest": "^
|
|
37
|
+
"typescript": "^5.5.3",
|
|
38
|
+
"vitest": "^2.0.0"
|
|
39
39
|
}
|
|
40
40
|
}
|
package/src/deep-merge.spec.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { describe,
|
|
1
|
+
import { describe, expect, it } from 'vitest'
|
|
2
2
|
import { deepMerge } from './deep-merge.js'
|
|
3
3
|
|
|
4
4
|
describe('DeepMerge tests', () => {
|
|
@@ -12,7 +12,7 @@ describe('DeepMerge tests', () => {
|
|
|
12
12
|
})
|
|
13
13
|
|
|
14
14
|
it('Should skip falsy sources', () => {
|
|
15
|
-
expect(deepMerge({ a: 1, b: 0, c: 0 }, null as any, { b: 2 }, { c: 3 })).toEqual({ a: 1, b: 2, c: 3 })
|
|
15
|
+
expect(deepMerge({ a: 1, b: 0, c: 0 }, null as any as {}, { b: 2 }, { c: 3 })).toEqual({ a: 1, b: 2, c: 3 })
|
|
16
16
|
})
|
|
17
17
|
|
|
18
18
|
it('Should override arrays', () => {
|
package/src/event-hub.spec.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { EventHub } from './event-hub.js'
|
|
2
1
|
import { describe, expect, it, vi } from 'vitest'
|
|
2
|
+
import { EventHub } from './event-hub.js'
|
|
3
3
|
|
|
4
4
|
describe('EventHub', () => {
|
|
5
5
|
it('Should fail on type errors', () => {
|
|
@@ -74,7 +74,7 @@ describe('EventHub', () => {
|
|
|
74
74
|
expect(objectListener2).toBeCalledTimes(1)
|
|
75
75
|
})
|
|
76
76
|
|
|
77
|
-
it('Should add and remove a listener with subscription', () => {
|
|
77
|
+
it('Should add and remove a listener with subscription', async () => {
|
|
78
78
|
const eventHub = new EventHub<{ ExampleNumberEvent: number }>()
|
|
79
79
|
const numberListener = vi.fn((_val: number) => {})
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ describe('EventHub', () => {
|
|
|
82
82
|
eventHub.emit('ExampleNumberEvent', 1)
|
|
83
83
|
|
|
84
84
|
expect(numberListener).toBeCalledWith(1)
|
|
85
|
-
subscription.dispose()
|
|
85
|
+
subscription[Symbol.dispose]()
|
|
86
86
|
eventHub.emit('ExampleNumberEvent', 2)
|
|
87
87
|
expect(numberListener).toBeCalledTimes(1)
|
|
88
88
|
})
|
|
@@ -93,7 +93,7 @@ describe('EventHub', () => {
|
|
|
93
93
|
const listener = vi.fn((_val: string) => {})
|
|
94
94
|
|
|
95
95
|
hub.addListener('test', listener)
|
|
96
|
-
hub.dispose()
|
|
96
|
+
hub[Symbol.dispose]()
|
|
97
97
|
hub.emit('test', 'test')
|
|
98
98
|
expect(listener).not.toBeCalled()
|
|
99
99
|
})
|
package/src/event-hub.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import type { Disposable } from './disposable.js'
|
|
2
|
-
|
|
3
1
|
type ListenerFunction<EventTypeMap extends Object, T extends keyof EventTypeMap> = (arg: EventTypeMap[T]) => void
|
|
4
2
|
|
|
5
3
|
export class EventHub<EventTypeMap extends Object> implements Disposable {
|
|
@@ -29,7 +27,7 @@ export class EventHub<EventTypeMap extends Object> implements Disposable {
|
|
|
29
27
|
listener: ListenerFunction<EventTypeMap, TEvent>,
|
|
30
28
|
): Disposable {
|
|
31
29
|
this.addListener(event, listener)
|
|
32
|
-
return { dispose: () => this.removeListener(event, listener) }
|
|
30
|
+
return { [Symbol.dispose]: () => this.removeListener(event, listener) }
|
|
33
31
|
}
|
|
34
32
|
|
|
35
33
|
public emit<TEvent extends keyof EventTypeMap>(event: TEvent, arg: EventTypeMap[TEvent]) {
|
|
@@ -38,7 +36,7 @@ export class EventHub<EventTypeMap extends Object> implements Disposable {
|
|
|
38
36
|
}
|
|
39
37
|
}
|
|
40
38
|
|
|
41
|
-
public dispose() {
|
|
39
|
+
public [Symbol.dispose]() {
|
|
42
40
|
this.listeners.clear()
|
|
43
41
|
}
|
|
44
42
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
export * from './disposable.js'
|
|
2
|
-
export * from './deep-merge.js'
|
|
3
1
|
export * from './debounce.js'
|
|
2
|
+
export * from './deep-merge.js'
|
|
4
3
|
export * from './event-hub.js'
|
|
4
|
+
export * from './is-async-disposable.js'
|
|
5
|
+
export * from './is-disposable.js'
|
|
5
6
|
export * from './observable-value.js'
|
|
6
|
-
export * from './value-observer.js'
|
|
7
7
|
export * from './path-helper.js'
|
|
8
8
|
export * from './sleep-async.js'
|
|
9
9
|
export * from './sort-by.js'
|
|
10
|
-
export * from './trace.js'
|
|
11
10
|
export * from './tuple.js'
|
|
11
|
+
export * from './using-async.js'
|
|
12
|
+
export * from './using.js'
|
|
13
|
+
export * from './value-observer.js'
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest'
|
|
2
|
+
import { isAsyncDisposable } from './is-async-disposable.js'
|
|
3
|
+
|
|
4
|
+
describe('isAsyndDisposable', () => {
|
|
5
|
+
it('should return true if the value is an instance of an async disposable object', () => {
|
|
6
|
+
const asyncDisposable = {
|
|
7
|
+
[Symbol.asyncDispose]: () => {},
|
|
8
|
+
}
|
|
9
|
+
expect(isAsyncDisposable(asyncDisposable)).toBe(true)
|
|
10
|
+
})
|
|
11
|
+
|
|
12
|
+
it('Should return false is the object has Symbol.asyncDispose but it is not a function', () => {
|
|
13
|
+
const asyncDisposable = {
|
|
14
|
+
[Symbol.asyncDispose]: 'not a function',
|
|
15
|
+
}
|
|
16
|
+
expect(isAsyncDisposable(asyncDisposable)).toBe(false)
|
|
17
|
+
})
|
|
18
|
+
|
|
19
|
+
it('Should return false is the object does not have Symbol.asyncDispose', () => {
|
|
20
|
+
const asyncDisposable = {}
|
|
21
|
+
expect(isAsyncDisposable(asyncDisposable)).toBe(false)
|
|
22
|
+
})
|
|
23
|
+
})
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @param value The value to check
|
|
4
|
+
* @returns if the value is an instance of an async disposable object
|
|
5
|
+
*/
|
|
6
|
+
export const isAsyncDisposable = (value: unknown): value is AsyncDisposable => {
|
|
7
|
+
return (value as AsyncDisposable)?.[Symbol.asyncDispose] instanceof Function
|
|
8
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest'
|
|
2
|
+
import { isDisposable } from './is-disposable.js'
|
|
3
|
+
|
|
4
|
+
describe('isDisposable', () => {
|
|
5
|
+
it('should return true if the value is an instance of a disposable object', () => {
|
|
6
|
+
const disposable = {
|
|
7
|
+
[Symbol.dispose]: () => {},
|
|
8
|
+
}
|
|
9
|
+
expect(isDisposable(disposable)).toBe(true)
|
|
10
|
+
})
|
|
11
|
+
|
|
12
|
+
it('Should return false is the object has Symbol.dispose but it is not a function', () => {
|
|
13
|
+
const disposable = {
|
|
14
|
+
[Symbol.dispose]: 'not a function',
|
|
15
|
+
}
|
|
16
|
+
expect(isDisposable(disposable)).toBe(false)
|
|
17
|
+
})
|
|
18
|
+
|
|
19
|
+
it('Should return false is the object does not have Symbol.dispose', () => {
|
|
20
|
+
const disposable = {}
|
|
21
|
+
expect(isDisposable(disposable)).toBe(false)
|
|
22
|
+
})
|
|
23
|
+
})
|