vivth 1.0.3 → 1.0.5

package/README.md

@@ -901,7 +901,7 @@ npm i vivth
 
 ```js
 /**
- * @template {AnyButUndefinedType} T
+ * @template {AnyButUndefined} T
  */
 ```
 
@@ -910,7 +910,7 @@ npm i vivth
 
 ```js
 /**
- * @param {Map<AnyButUndefinedType, [Promise<any>, {}]>} uniqueMap 	 
+ * @param {Map<AnyButUndefined, [Promise<any>, {}]>} uniqueMap 	 
  * @returns {typeof QChannel} 	 
  * - usefull for Queue primitive on multiple library but single reference, like the Web by making the `Map` on `window` object;
  */
@@ -1676,10 +1676,12 @@ npm i vivth
 - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;  
 - this class also is used to generate this `README.md`;  
 - behaviours:  
->1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
->2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
->3) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
->4) extract `"at"description` jsdoc:  
+>1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;  
+>>- auto export must follows the following rules, and there's no way to override;  
+>2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;  
+>3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;  
+>4) create `README.md` based on, `options.paths.dir` and `README.src.md`;  
+>5) extract `"at"description` jsdoc:  
 >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;  
 >>- `"at"description` are treated as plain `markdown`;  
 >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;  

package/bun.lock

@@ -10,7 +10,7 @@
       "devDependencies": {
         "@types/bun": "latest",
         "concurrently": "^9.2.1",
-        "typescript": "^5.8.3",
+        "typescript": "^5.9.2",
       },
     },
   },

package/index.mjs

@@ -1,7 +1,7 @@
 // @ts-check
 
 /**
- * automatically generated by `vivth.MJSautoDOC`
+ * automatically generated by `vivth.JSautoDOC`
  * @copyright
  * this library is made and distributed under MIT license;
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vivth",
-	"version": "1.0.3",
+	"version": "1.0.5",
 	"description": "extremely simple signal as library primitives",
 	"main": "index.mjs",
 	"types": "./types/index.d.mts",

package/src/class/QChannel.mjs

@@ -6,18 +6,18 @@ import { TryAsync } from '../function/TryAsync.mjs';
 /**
  * @description
  * - class for `Queue` handling;
- * @template {AnyButUndefinedType} T
+ * @template {AnyButUndefined} T
  */
 export class QChannel {
 	/**
-	 * @typedef {import('../types/AnyButUndefined.mjs').AnyButUndefined} AnyButUndefinedType
+	 * @typedef {import('../types/AnyButUndefined.mjs').AnyButUndefined} AnyButUndefined
 	 * @typedef {import('../types/QCBReturn.mjs').QCBReturn} QCBReturn
 	 * @typedef {import('../types/QCBFIFOReturn.mjs').QCBFIFOReturn} QCBFIFOReturn
 	 */
 	/**
 	 * @description
 	 * - to modify `MapReference`
-	 * @param {Map<AnyButUndefinedType, [Promise<any>, {}]>} uniqueMap
+	 * @param {Map<AnyButUndefined, [Promise<any>, {}]>} uniqueMap
 	 * @returns {typeof QChannel}
 	 * - usefull for Queue primitive on multiple library but single reference, like the Web by making the `Map` on `window` object;
 	 */
@@ -26,13 +26,13 @@ export class QChannel {
 		return QChannel;
 	};
 	/**
-	 * @type {Map<AnyButUndefinedType, [Promise<any>, {}]>}
+	 * @type {Map<AnyButUndefined, [Promise<any>, {}]>}
 	 */
 	static #uniquePromiser = new Map();
 	/**
 	 * - ensures that each id has only one task running at a time.
 	 * - calls with the same id will wait for the previous call to finish.
-	 * @param {AnyButUndefinedType} id
+	 * @param {AnyButUndefined} id
 	 * @returns {Promise<QCBReturn>} Resolves when it's safe to proceed for the given id, returning a cleanup function
 	 */
 	static #uniqueCB = async (id) => {

package/src/doc/JSautoDOC.mjs

@@ -37,10 +37,12 @@ const acceptableExt = new Set(['.mjs', '.mts', '.ts']);
  * - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;
  * - this class also is used to generate this `README.md`;
  * - behaviours:
- * >1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
- * >2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
- * >3) create `README.md` based on, `options.paths.dir` and `README.src.md`;
- * >4) extract `"at"description` jsdoc:
+ * >1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;
+ * >>- auto export must follows the following rules, and there's no way to override;
+ * >2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
+ * >3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
+ * >4) create `README.md` based on, `options.paths.dir` and `README.src.md`;
+ * >5) extract `"at"description` jsdoc:
  * >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;
  * >>- `"at"description` are treated as plain `markdown`;
  * >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;
@@ -226,7 +228,7 @@ export class JSautoDOC {
 	 * @returns {string}
 	 */
 	#generateJSDOCFromstring = (string) => {
-		return `\n/**\n * automatically generated by \`vivth.MJSautoDOC\`\n * @copyright\n${string.replace(
+		return `\n/**\n * automatically generated by \`vivth.JSautoDOC\`\n * @copyright\n${string.replace(
 			/^/gm,
 			' * '
 		)}\n */\n`;
@@ -250,6 +252,7 @@ export class JSautoDOC {
 		for await (const path_ of filepaths) {
 			const {
 				documented,
+				content,
 				hasValidExportObject,
 				path: { relative: relativePath },
 				baseName: { noExt },
@@ -272,13 +275,15 @@ export class JSautoDOC {
 			});
 			if (!error && typedefString) {
 				mjsTypes.push(typedefString.module);
-				const nameVarID = noExt.toLowerCase();
-				tableOfContent.push(`[${noExt}](#${nameVarID})`);
-				apiDocuments.push(
-					`<h2 id="${nameVarID}">${noExt}</h2>\n\n- jsdoc types:\n\n\`\`\`js\n${
-						typedefString.readme
-					}\n\`\`\`\n*) <sub>[go to ${this.#tableOfContentTitle}](#${tableID})</sub>`
-				);
+				if (!/\/\*\*[\s\*]*?@noautodoc[\s\*]*?\*\//.test(await content.string())) {
+					const nameVarID = noExt.toLowerCase();
+					tableOfContent.push(`[${noExt}](#${nameVarID})`);
+					apiDocuments.push(
+						`<h2 id="${nameVarID}">${noExt}</h2>\n\n- jsdoc types:\n\n\`\`\`js\n${
+							typedefString.readme
+						}\n\`\`\`\n*) <sub>[go to ${this.#tableOfContentTitle}](#${tableID})</sub>`
+					);
+				}
 			}
 			readme.forEach((ref) => {
 				const {

package/src/types/AnyButUndefined.mjs

@@ -1,5 +1,4 @@
 // @ts-check
-
 /**
  * - type helper for ID or objects;
  * @typedef {{}|null|number|string|boolean|symbol|bigint|function} AnyButUndefined

package/types/src/class/QChannel.d.mts

@@ -1,30 +1,30 @@
 /**
  * @description
  * - class for `Queue` handling;
- * @template {AnyButUndefinedType} T
+ * @template {AnyButUndefined} T
  */
 export class QChannel<T extends import("../types/AnyButUndefined.mjs").AnyButUndefined> {
     /**
-     * @typedef {import('../types/AnyButUndefined.mjs').AnyButUndefined} AnyButUndefinedType
+     * @typedef {import('../types/AnyButUndefined.mjs').AnyButUndefined} AnyButUndefined
      * @typedef {import('../types/QCBReturn.mjs').QCBReturn} QCBReturn
      * @typedef {import('../types/QCBFIFOReturn.mjs').QCBFIFOReturn} QCBFIFOReturn
      */
     /**
      * @description
      * - to modify `MapReference`
-     * @param {Map<AnyButUndefinedType, [Promise<any>, {}]>} uniqueMap
+     * @param {Map<AnyButUndefined, [Promise<any>, {}]>} uniqueMap
      * @returns {typeof QChannel}
      * - usefull for Queue primitive on multiple library but single reference, like the Web by making the `Map` on `window` object;
      */
     static makeQClass: (uniqueMap: Map<import("../types/AnyButUndefined.mjs").AnyButUndefined, [Promise<any>, {}]>) => typeof QChannel;
     /**
-     * @type {Map<AnyButUndefinedType, [Promise<any>, {}]>}
+     * @type {Map<AnyButUndefined, [Promise<any>, {}]>}
      */
     static #uniquePromiser: Map<import("../types/AnyButUndefined.mjs").AnyButUndefined, [Promise<any>, {}]>;
     /**
      * - ensures that each id has only one task running at a time.
      * - calls with the same id will wait for the previous call to finish.
-     * @param {AnyButUndefinedType} id
+     * @param {AnyButUndefined} id
      * @returns {Promise<QCBReturn>} Resolves when it's safe to proceed for the given id, returning a cleanup function
      */
     static #uniqueCB: (id: import("../types/AnyButUndefined.mjs").AnyButUndefined) => Promise<import("../types/QCBReturn.mjs").QCBReturn>;

package/types/src/doc/JSautoDOC.d.mts

@@ -4,10 +4,12 @@
  * - this autodocumenter uses [chokidar](https://npmjs.com/package/chokidar) under the hood;
  * - this class also is used to generate this `README.md`;
  * - behaviours:
- * >1) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
- * >2) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
- * >3) create `README.md` based on, `options.paths.dir` and `README.src.md`;
- * >4) extract `"at"description` jsdoc:
+ * >1) add `"at"noautodoc` on self closing jsdoc comment to opt out from generating documentation on said file;
+ * >>- auto export must follows the following rules, and there's no way to override;
+ * >2) export all named exported 'const'|'function'|'async function'|'class', alphanumeric name, started with Capital letter, same name with fileName on `options.pahts.file`;
+ * >3) declare typedef of existing typedef with alphanumeric name, started with Capital letter, same name with fileName, and have no valid export like on point <sup>1</sup> on `options.pahts.file`;
+ * >4) create `README.md` based on, `options.paths.dir` and `README.src.md`;
+ * >5) extract `"at"description` jsdoc:
  * >>- on static/prop that have depths, all of children should have `"at"static`/`"at"instance` `nameOfImmediateParent`, same block but before `"at"description` comment line;
  * >>- `"at"description` are treated as plain `markdown`;
  * >>- first `"at"${string}` after `"at"description` until `"at"example` will be treated as `javascript` comment block on the `markdown`;