vivth 1.0.4 → 1.0.6

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;
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vivth",
-	"version": "1.0.4",
+	"version": "1.0.6",
 	"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

@@ -257,6 +257,7 @@ export class JSautoDOC {
 				path: { relative: relativePath },
 				baseName: { noExt },
 			} = (await this.#parsedFilesRef.get(path_)).value;
+			const hasNoAutoDoc = /\/\*\*[\s\*]*?@noautodoc[\s\*]*?\*\//.test(await content.string());
 			if (hasValidExportObject) {
 				mjsMain.push(
 					`export { ${noExt} } from '${
@@ -264,9 +265,6 @@ export class JSautoDOC {
 					}';`
 				);
 			}
-			if (/\/\*\*[\s\*]*?@noautodoc[\s\*]*?\*\//.test(await content.string())) {
-				continue;
-			}
 			const currentDescription = [];
 			const { readme, typedef } = documented;
 			const [typedefString, error] = await TryAsync(async () => {
@@ -278,27 +276,29 @@ 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 (!hasNoAutoDoc) {
+					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 {
-					// fullDescription,
-					// instanceOrStatic,
-					// namedVar,
-					// typeOfVar,
-					parsedFullDescription,
-					reference,
-				} = ref;
-				const { description, jsPreview } = parsedFullDescription;
-				currentDescription.push(`\n#### reference:${reference}\n${description}\n${jsPreview}`);
-			});
-			if (hasValidExportObject) {
+			if (!hasNoAutoDoc && hasValidExportObject) {
+				readme.forEach((ref) => {
+					const {
+						// fullDescription,
+						// instanceOrStatic,
+						// namedVar,
+						// typeOfVar,
+						parsedFullDescription,
+						reference,
+					} = ref;
+					const { description, jsPreview } = parsedFullDescription;
+					currentDescription.push(`\n#### reference:${reference}\n${description}\n${jsPreview}`);
+				});
 				const nameVarID = noExt.toLowerCase();
 				tableOfContent.push(`[${noExt}](#${noExt.toLowerCase()})`);
 				apiDocuments.push(

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>;