@ndriadev/futurable 2.2.0 → 2.2.2

package/README.md

@@ -1,4 +1,13 @@
-<h1 align="center">Futurable</h1>
+<h1 align="center">
+  	<br>
+	<a href="https://futurable.ndria.dev/">
+  		<img src="https://futurable.ndria.dev/Futurable.png" alt="logo">
+	</a>
+	<br>
+	Futurable
+	<br>
+</h1>
+
 <h3 align="center">Javascript's Promise and Fetch API with super powers!</h3>
 
 <div align="center">
@@ -611,11 +620,11 @@ Extension of static method _withResolvers_ with support of _cancel_ function and
 *Example*
 ```javascript
 //...code
-const {futurable, resolve, reject} = Futurable.withResolvers();
+const {promise, resolve, reject} = Futurable.withResolvers();
 
 //...code
 
-const result = await futurable;
+const result = await promise;
 
 //...code
 resolve("resolved");

package/package.json

@@ -2,7 +2,7 @@
   "name": "@ndriadev/futurable",
   "description": "Extension Javascript's Promise API with more functionalities",
   "private": false,
-  "version": "2.2.0",
+  "version": "2.2.2",
   "type": "module",
   "files": [
     "dist/",
@@ -32,11 +32,15 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.3",
+    "express": "^4.19.2",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typedoc": "^0.25.7",
+    "typedoc-material-theme": "^1.0.2",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typedoc-plugin-keywords": "^1.6.0",
     "typescript": "^5.3.3",
     "vite": "^5.0.12",
     "vite-plugin-dts": "^3.7.2",
@@ -81,10 +85,11 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "lint": "eslint 'src/**/*.{js,jsx,ts,tsx}'",
     "lint:fix": "eslint --fix 'src/**/*.{jsx,ts,tsx}'",
-    "docs": "typedoc src/index.ts --out docs",
+    "docs": "typedoc --options typedoc.config.cjs && node scripts/copy-resources.js",
     "release:patch": "pnpm version patch",
     "release:minor": "pnpm version minor",
     "release:major": "pnpm version major",
-    "postversion": "pnpm run docs && git add . && git commit -m '[FIX] docs' && git push && git push origin --tags && pnpm publish --access public"
+    "postversion": "pnpm run docs && git add . && git commit -m '[FIX] docs' && git push && git push origin --tags && pnpm publish --access public",
+    "preview": "pnpm run docs && node scripts/server.js"
   }
 }

package/scripts/copy-resources.js

@@ -0,0 +1,18 @@
+import { readFile, readdir, writeFile } from 'fs/promises';
+import path from 'path';
+
+const __dirname = new URL('.', import.meta.url).pathname;
+
+async function copy() {
+	try {
+		const dir = await readdir(path.join(__dirname, "..", "resources", "images"));
+		for (const file of dir) {
+			const asset = await readFile(path.join(__dirname, "..", "resources", "images", file));
+			await writeFile(path.join(__dirname, "..", "docs", file), asset);
+		}
+	} catch (error) {
+		console.error(error);
+	}
+}
+
+copy();

package/scripts/server.js

@@ -0,0 +1,16 @@
+import express from 'express';
+import path from 'path';
+
+const __dirname = new URL('.', import.meta.url).pathname;
+
+const app = express();
+
+app.use(express.static(path.join((__dirname, "..", "docs"))));
+
+app.get('/', (req, res) => {
+	return res.sendFile(path.join(__dirname, '..', 'docs', 'index.html'))
+});
+
+app.listen(4173, () => {
+	console.log("run");
+});