@alwatr/flatomise 5.0.0 → 5.4.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 CHANGED
@@ -3,6 +3,52 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [5.4.0](https://github.com/Alwatr/nanolib/compare/@alwatr/flatomise@1.2.8...@alwatr/flatomise@5.4.0) (2025-02-18)
7
+
8
+ ### Features
9
+
10
+ * enhance Flatomise interface with promise settlement tracking ([692e7ff](https://github.com/Alwatr/nanolib/commit/692e7ff5ddbc2efef16aaa2ecbeff90e55d63e2a)) by @
11
+
12
+ ### Code Refactoring
13
+
14
+ * make Flatomise properties readonly for immutability ([14dd30f](https://github.com/Alwatr/nanolib/commit/14dd30f6615d6e4cddf125803267fc9a817f59ac)) by @
15
+
16
+ ### Dependencies update
17
+
18
+ * **flatomise:** add @alwatr/type-helper to dependencies and TypeScript types ([7a489ab](https://github.com/Alwatr/nanolib/commit/7a489abd39aac2c1189e6697025f82af196e2fe9)) by @
19
+
20
+ ## 5.3.0 (2025-02-03)
21
+
22
+ ### Miscellaneous Chores
23
+
24
+ * edit README ([3860b3d](https://github.com/Alwatr/nanolib/commit/3860b3df48ab82dc479d5236c2e8579df614aabf)) by @
25
+
26
+ ### Dependencies update
27
+
28
+ * bump the development-dependencies group across 1 directory with 11 updates ([cb79d07](https://github.com/Alwatr/nanolib/commit/cb79d072a57c79e1c01abff1a293d6757bb65350)) by @
29
+ * update typescript and @types/node to version 5.7.3 and 22.13.0 respectively across multiple packages ([ddab05b](https://github.com/Alwatr/nanolib/commit/ddab05b5d767c30191f36a065e4bc88744e8e3fe)) by @
30
+
31
+ ## 5.0.0 (2024-11-02)
32
+
33
+ ### ⚠ BREAKING CHANGES
34
+
35
+ * To simplify version management and ensure consistency, all nanolib packages now use the same version as @alwatr/nanolib. This may require updates to your project's dependencies.
36
+
37
+ ### Code Refactoring
38
+
39
+ * use the same version as @alwatr/nanolib ([60eb860](https://github.com/Alwatr/nanolib/commit/60eb860a0e33dfffe2d1d95e63ce54c60876be06)) by @
40
+
41
+ ## [5.3.0](https://github.com/Alwatr/nanolib/compare/v5.2.1...v5.3.0) (2025-02-03)
42
+
43
+ ### Miscellaneous Chores
44
+
45
+ * edit README ([3860b3d](https://github.com/Alwatr/nanolib/commit/3860b3df48ab82dc479d5236c2e8579df614aabf)) by @ArmanAsadian
46
+
47
+ ### Dependencies update
48
+
49
+ * bump the development-dependencies group across 1 directory with 11 updates ([cb79d07](https://github.com/Alwatr/nanolib/commit/cb79d072a57c79e1c01abff1a293d6757bb65350)) by @dependabot[bot]
50
+ * update typescript and @types/node to version 5.7.3 and 22.13.0 respectively across multiple packages ([ddab05b](https://github.com/Alwatr/nanolib/commit/ddab05b5d767c30191f36a065e4bc88744e8e3fe)) by @alimd
51
+
6
52
  ## 5.0.0 (2024-11-02)
7
53
 
8
54
  ### ⚠ BREAKING CHANGES
package/README.md CHANGED
@@ -26,8 +26,6 @@ For real usage, see [async-queue](https://github.com/Alwatr/nanolib/blob/next/pa
26
26
 
27
27
  The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
28
28
 
29
- [![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
30
-
31
29
  ### Contributing
32
30
 
33
31
  Contributions are welcome! Please read our [contribution guidelines](https://github.com/Alwatr/.github/blob/next/CONTRIBUTING.md) before submitting a pull request.
package/dist/main.cjs CHANGED
@@ -1,4 +1,4 @@
1
- /* @alwatr/flatomise v5.0.0 */
1
+ /* @alwatr/flatomise v5.4.0 */
2
2
  "use strict";
3
3
  var __defProp = Object.defineProperty;
4
4
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -25,18 +25,20 @@ __export(main_exports, {
25
25
  });
26
26
  module.exports = __toCommonJS(main_exports);
27
27
  var import_package_tracer = require("@alwatr/package-tracer");
28
- __dev_mode__: import_package_tracer.packageTracer.add("@alwatr/flatomise", "5.0.0");
28
+ __dev_mode__: import_package_tracer.packageTracer.add("@alwatr/flatomise", "5.4.0");
29
29
  function newFlatomise() {
30
- const flatomise = {};
30
+ const flatomise = { settled: false };
31
31
  flatomise.promise = new Promise((resolve, reject) => {
32
32
  flatomise.resolve = resolve;
33
33
  flatomise.reject = reject;
34
34
  });
35
+ flatomise.promise.finally(() => {
36
+ flatomise.settled = true;
37
+ });
35
38
  return flatomise;
36
39
  }
37
40
  // Annotate the CommonJS export names for ESM import in node:
38
41
  0 && (module.exports = {
39
42
  newFlatomise
40
43
  });
41
- /*! For license information please see main.cjs.LEGAL.txt */
42
44
  //# sourceMappingURL=main.cjs.map
package/dist/main.cjs.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../src/main.ts"],
4
- "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n promise: Promise<T>;\n resolve: (value: T | PromiseLike<T>) => void;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n reject: (reason?: any) => void;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n * console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n const flatomise: Partial<Flatomise<T>> = {};\n flatomise.promise = new Promise<T>((resolve, reject) => {\n flatomise.resolve = resolve;\n flatomise.reject = reject;\n });\n return flatomise as Flatomise<T>;\n}\n"],
5
- "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,qBAAkB,OAAmB;AA0B9D,SAAS,eAAgC;AAC9C,QAAM,YAAmC,CAAC;AAC1C,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,SAAO;AACT;",
4
+ "sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n /**\n * The promise.\n */\n readonly promise: Promise<T>;\n\n /**\n * Resolve the promise.\n */\n readonly resolve: (value: T | PromiseLike<T>) => void;\n\n /**\n * Reject the promise.\n */\n readonly reject: (reason?: any) => void;\n\n /**\n * Whether the promise is settled (resolved or rejected).\n */\n readonly settled: boolean;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n * console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n const flatomise: Partial<Mutable<Flatomise<T>>> = {settled: false};\n flatomise.promise = new Promise<T>((resolve, reject) => {\n flatomise.resolve = resolve;\n flatomise.reject = reject;\n });\n flatomise.promise.finally(() => {\n flatomise.settled = true;\n });\n return flatomise as Flatomise<T>;\n}\n"],
5
+ "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,4BAA4B;AAE5B,aAAc,qCAAc,IAAI,qBAAkB,OAAmB;AAyC9D,SAAS,eAAgC;AAC9C,QAAM,YAA4C,EAAC,SAAS,MAAK;AACjE,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,YAAU,QAAQ,QAAQ,MAAM;AAC9B,cAAU,UAAU;AAAA,EACtB,CAAC;AACD,SAAO;AACT;",
6
6
  "names": []
7
7
  }
package/dist/main.d.ts CHANGED
@@ -2,9 +2,22 @@
2
2
  * Flat promise that can be resolved or rejected from outside.
3
3
  */
4
4
  export interface Flatomise<T> {
5
- promise: Promise<T>;
6
- resolve: (value: T | PromiseLike<T>) => void;
7
- reject: (reason?: any) => void;
5
+ /**
6
+ * The promise.
7
+ */
8
+ readonly promise: Promise<T>;
9
+ /**
10
+ * Resolve the promise.
11
+ */
12
+ readonly resolve: (value: T | PromiseLike<T>) => void;
13
+ /**
14
+ * Reject the promise.
15
+ */
16
+ readonly reject: (reason?: any) => void;
17
+ /**
18
+ * Whether the promise is settled (resolved or rejected).
19
+ */
20
+ readonly settled: boolean;
8
21
  }
9
22
  /**
10
23
  * Create a new Flatomise is a promise that can be resolved or rejected from outside.
@@ -1 +1 @@
1
- {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE7C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAO9C"}
1
+ {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAU9C"}
package/dist/main.mjs CHANGED
@@ -1,18 +1,20 @@
1
- /* @alwatr/flatomise v5.0.0 */
1
+ /* @alwatr/flatomise v5.4.0 */
2
2
 
3
3
  // src/main.ts
4
4
  import { packageTracer } from "@alwatr/package-tracer";
5
- __dev_mode__: packageTracer.add("@alwatr/flatomise", "5.0.0");
5
+ __dev_mode__: packageTracer.add("@alwatr/flatomise", "5.4.0");
6
6
  function newFlatomise() {
7
- const flatomise = {};
7
+ const flatomise = { settled: false };
8
8
  flatomise.promise = new Promise((resolve, reject) => {
9
9
  flatomise.resolve = resolve;
10
10
  flatomise.reject = reject;
11
11
  });
12
+ flatomise.promise.finally(() => {
13
+ flatomise.settled = true;
14
+ });
12
15
  return flatomise;
13
16
  }
14
17
  export {
15
18
  newFlatomise
16
19
  };
17
- /*! For license information please see main.mjs.LEGAL.txt */
18
20
  //# sourceMappingURL=main.mjs.map
package/dist/main.mjs.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../src/main.ts"],
4
- "sourcesContent": ["import {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n promise: Promise<T>;\n resolve: (value: T | PromiseLike<T>) => void;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n reject: (reason?: any) => void;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n * console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n const flatomise: Partial<Flatomise<T>> = {};\n flatomise.promise = new Promise<T>((resolve, reject) => {\n flatomise.resolve = resolve;\n flatomise.reject = reject;\n });\n return flatomise as Flatomise<T>;\n}\n"],
5
- "mappings": ";;;AAAA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,qBAAkB,OAAmB;AA0B9D,SAAS,eAAgC;AAC9C,QAAM,YAAmC,CAAC;AAC1C,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,SAAO;AACT;",
4
+ "sourcesContent": ["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport {packageTracer} from '@alwatr/package-tracer';\n\n__dev_mode__: packageTracer.add(__package_name__, __package_version__);\n\n/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise<T> {\n /**\n * The promise.\n */\n readonly promise: Promise<T>;\n\n /**\n * Resolve the promise.\n */\n readonly resolve: (value: T | PromiseLike<T>) => void;\n\n /**\n * Reject the promise.\n */\n readonly reject: (reason?: any) => void;\n\n /**\n * Whether the promise is settled (resolved or rejected).\n */\n readonly settled: boolean;\n}\n\n/**\n * Create a new Flatomise is a promise that can be resolved or rejected from outside.\n *\n * @returns A new Flatomise.\n *\n * @example\n * ```typescript\n * const flatomise = newFlatomise();\n * flatomise.promise.then(() => {\n * console.log('flatomise resolved');\n * });\n * flatomise.resolve();\n * ```\n */\nexport function newFlatomise<T>(): Flatomise<T> {\n const flatomise: Partial<Mutable<Flatomise<T>>> = {settled: false};\n flatomise.promise = new Promise<T>((resolve, reject) => {\n flatomise.resolve = resolve;\n flatomise.reject = reject;\n });\n flatomise.promise.finally(() => {\n flatomise.settled = true;\n });\n return flatomise as Flatomise<T>;\n}\n"],
5
+ "mappings": ";;;AACA,SAAQ,qBAAoB;AAE5B,aAAc,eAAc,IAAI,qBAAkB,OAAmB;AAyC9D,SAAS,eAAgC;AAC9C,QAAM,YAA4C,EAAC,SAAS,MAAK;AACjE,YAAU,UAAU,IAAI,QAAW,CAAC,SAAS,WAAW;AACtD,cAAU,UAAU;AACpB,cAAU,SAAS;AAAA,EACrB,CAAC;AACD,YAAU,QAAQ,QAAQ,MAAM;AAC9B,cAAU,UAAU;AAAA,EACtB,CAAC;AACD,SAAO;AACT;",
6
6
  "names": []
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alwatr/flatomise",
3
- "version": "5.0.0",
3
+ "version": "5.4.0",
4
4
  "description": "A utility for creating promises that can be externally resolved or rejected.",
5
5
  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
6
6
  "keywords": [
@@ -66,13 +66,14 @@
66
66
  "clean": "rm -rfv dist *.tsbuildinfo"
67
67
  },
68
68
  "dependencies": {
69
- "@alwatr/package-tracer": "^5.0.0"
69
+ "@alwatr/package-tracer": "^5.4.0"
70
70
  },
71
71
  "devDependencies": {
72
- "@alwatr/nano-build": "^5.0.0",
72
+ "@alwatr/nano-build": "^5.4.0",
73
73
  "@alwatr/prettier-config": "^5.0.0",
74
74
  "@alwatr/tsconfig-base": "^5.0.0",
75
- "typescript": "^5.6.3"
75
+ "@alwatr/type-helper": "^5.3.0",
76
+ "typescript": "^5.7.3"
76
77
  },
77
- "gitHead": "7d12943fafa8ef50636346e66ff56c50e2fd0c72"
78
+ "gitHead": "074be0d0fe780bf929e163045f8f598cd2697636"
78
79
  }
File without changes
File without changes