[FIX] generateMarkdown.js

Author: nDriaDev

.gitignore

@@ -1 +1,2 @@
 node_modules
+.vscode

apps/react-tools-demo/scripts/generateMarkdown.js

@@ -242,6 +242,15 @@ function buildHooksUtilsMarkdownObject(file) {
 				type: getTypeString(returnSplitted, true),
 				...getNameDescriptionParam(returnSplitted)
 			};
+			let lastDescriptionIndex = index+1;
+			while(lastDescriptionIndex < lines.length && ![" */", "*/"].includes(lines[lastDescriptionIndex])) {
+				lastDescriptionIndex++;
+			}
+			if(lastDescriptionIndex !== index+1) {
+				const temp = returns.type.join("\n").substring(1);
+				returns.description = temp;
+				returns.type = lines.splice(index+1, lastDescriptionIndex-1).map(el => el.split(" * ")[1]);
+			}
 			obj.returns = returns;
 		}
 		if(depuratedLine.startsWith("__") || depuratedLine.startsWith("**")) {

apps/react-tools-demo/src/markdown/useBattery.md

@@ -10,7 +10,7 @@ export const UseBattery = () => {
 	return (<div style={{ textAlign: "center" }}>
 		{
 			Object.keys(status).map(el => (
-				<p key={el}>{el}: {JSON.stringify(status[el as keyof typeof status])}</p>
+				<p key={el}>{el}: {status[el as keyof typeof status]}</p>
 			))
 		}
 	</div>)
@@ -23,7 +23,7 @@ export const UseBattery = () => {
 ## API
 
 ```tsx
-useBattery (opts?: { onChargingChange?: (evt: Event) => void, onChargingTimeChange?: (evt: Event) => void, onDischargingTimeChange?: (evt: Event) => void, onLevelChange?: (evt: Event) => void }): BatteryStatus 
+useBattery * - __isSupported__: boolean that indicates if Battery Status API is available.
 ```
 
 > ### Params
@@ -42,6 +42,11 @@ callback that will be executed when levelchange event is fired.
 
 > ### Returns
 >
-> __result__: object:
-> - _BatteryStatus_  
+> __result__:  _BatteryStatus_  
+> Object with:
+> - __isSupported__: boolean that indicates if Battery Status API is available.
+> - __level__: number that indicates battery level: is a number between 0 and 1.
+> - __charging__: boolean that indicates if battery is charging.
+> - __chargingTime__: number that indicates time in seconds remaining to full charge, or infinity.
+> - __dischargingTime__: number that indicates time in seconds remaining to empty charge, rounded in 15 minutes by API.
 >

packages/react-tools/src/hooks/useBattery.ts

@@ -18,7 +18,8 @@ let batteryCached: undefined | BatteryStatus & { onchargingchange: null | ((evt:
  * @param {(evt: Event) => void} [opts.onChargingTimeChange] - callback that will be executed when chargingtimechange event is fired.
  * @param {(evt: Event) => void} [opts.onDischargingTimeChange] - callback that will be executed when dischargingtimechange event is fired.
  * @param {(evt: Event) => void} [opts.onLevelChange] - callback that will be executed when levelchange event is fired.
- * @returns {BatteryStatus} result - object:
+ * @returns {BatteryStatus} result
+ * Object with:
  * - __isSupported__: boolean that indicates if Battery Status API is available.
  * - __level__: number that indicates battery level: is a number between 0 and 1.
  * - __charging__: boolean that indicates if battery is charging.