@alwatr/flatomise 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2024-01-03)
+
+### Features
+
+* **flatomise:** A utility for creating promises that can be externally resolved or rejected. ([1bc4478](https://github.com/Alwatr/nanolib/commit/1bc4478327f156b5e45650590aea013590443723)) by @AliMD

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# Flatomise
+
+A utility for creating promises that can be externally resolved or rejected.
+
+## Installation
+
+```bash
+yarn add @alwatr/flatomise
+```
+
+## Usage
+
+```typescript
+import {newFlatomise} from '@alwatr/flatomise';
+
+const flatomise = newFlatomise();
+flatomise.promise.then(() => {
+  console.log('flatomise resolved');
+});
+flatomise.resolve();
+```
+
+For real usage, see [async-queue](https://github.com/Alwatr/nanolib/blob/next/packages/async-quque/src/main.ts).

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/flatomise v1.0.0 */
+"use strict";var r=Object.defineProperty;var a=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var l=Object.prototype.hasOwnProperty;var n=(e,o)=>{for(var i in o)r(e,i,{get:o[i],enumerable:!0})},v=(e,o,i,s)=>{if(o&&typeof o=="object"||typeof o=="function")for(let t of m(o))!l.call(e,t)&&t!==i&&r(e,t,{get:()=>o[t],enumerable:!(s=a(o,t))||s.enumerable});return e};var c=e=>v(r({},"__esModule",{value:!0}),e);var d={};n(d,{newFlatomise:()=>F});module.exports=c(d);function F(){let e={};return e.promise=new Promise((o,i)=>{e.resolve=o,e.reject=i}),e}0&&(module.exports={newFlatomise});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise {\n  promise: Promise<void>;\n  resolve: () => void;\n  reject: () => 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(): Flatomise {\n  const flatomise: Partial<Flatomise> = {};\n  flatomise.promise = new Promise<void>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  return flatomise as Flatomise;\n}\n"],
+  "mappings": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,kBAAAE,IAAA,eAAAC,EAAAH,GAuBO,SAASE,GAA0B,CACxC,IAAME,EAAgC,CAAC,EACvC,OAAAA,EAAU,QAAU,IAAI,QAAc,CAACC,EAASC,IAAW,CACzDF,EAAU,QAAUC,EACpBD,EAAU,OAASE,CACrB,CAAC,EACMF,CACT",
+  "names": ["main_exports", "__export", "newFlatomise", "__toCommonJS", "flatomise", "resolve", "reject"]
+}

package/dist/main.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Flat promise that can be resolved or rejected from outside.
+ */
+export interface Flatomise {
+    promise: Promise<void>;
+    resolve: () => void;
+    reject: () => void;
+}
+/**
+ * Create a new Flatomise is a promise that can be resolved or rejected from outside.
+ *
+ * @returns A new Flatomise.
+ *
+ * @example
+ * ```typescript
+ * const flatomise = newFlatomise();
+ * flatomise.promise.then(() => {
+ *   console.log('flatomise resolved');
+ * });
+ * flatomise.resolve();
+ * ```
+ */
+export declare function newFlatomise(): Flatomise;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,IAAI,CAAC;CACpB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,IAAI,SAAS,CAOxC"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/flatomise v1.0.0 */
+function t(){let e={};return e.promise=new Promise((o,i)=>{e.resolve=o,e.reject=i}),e}export{t as newFlatomise};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * Flat promise that can be resolved or rejected from outside.\n */\nexport interface Flatomise {\n  promise: Promise<void>;\n  resolve: () => void;\n  reject: () => 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(): Flatomise {\n  const flatomise: Partial<Flatomise> = {};\n  flatomise.promise = new Promise<void>((resolve, reject) => {\n    flatomise.resolve = resolve;\n    flatomise.reject = reject;\n  });\n  return flatomise as Flatomise;\n}\n"],
+  "mappings": ";AAuBO,SAASA,GAA0B,CACxC,IAAMC,EAAgC,CAAC,EACvC,OAAAA,EAAU,QAAU,IAAI,QAAc,CAACC,EAASC,IAAW,CACzDF,EAAU,QAAUC,EACpBD,EAAU,OAASE,CACrB,CAAC,EACMF,CACT",
+  "names": ["newFlatomise", "flatomise", "resolve", "reject"]
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@alwatr/flatomise",
+  "version": "1.0.0",
+  "description": "A utility for creating promises that can be externally resolved or rejected.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "flatomise",
+    "flat-promise",
+    "promise",
+    "cross-platform",
+    "ECMAScript",
+    "typescript",
+    "javascript",
+    "node",
+    "nodejs",
+    "esm",
+    "module",
+    "utility",
+    "util",
+    "utils",
+    "nanolib",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{js,mjs,cjs,map,d.ts,html,md}",
+    "!demo/**/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/flatomise"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/flatomise#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "prettier": "@alwatr/prettier-config",
+  "scripts": {
+    "b": "yarn run build",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && ALWATR_DEBUG=1 yarn node",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build --preset=module",
+    "build:ts": "tsc --build",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist *.tsbuildinfo"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.2.3",
+    "@alwatr/prettier-config": "^1.0.4",
+    "@alwatr/tsconfig-base": "^1.1.0",
+    "@types/node": "^20.10.6",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "154de55566d7f39bba46d269585bae838499f0bf"
+}