Fix timeout hook documentation

Author: amanteaux

templates/admin/src/lib/plume-http-react-hook-loader/observableLoaderHook.ts

@@ -109,7 +109,7 @@ export function useObservableLoaderConfigurable<T extends ObservableDataHandler<
     .map((dataObservable: ObservableDataHandler<any>) => {
       // the number of observable sources is fixed and cannot change,
       // so the number of time useObservable is called will be stable
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any,react-hooks/rules-of-hooks
+      // eslint-disable-next-line react-hooks/rules-of-hooks
       const data: T = useObservable(dataObservable.dataObservable);
 
       return {
@@ -180,6 +180,7 @@ export function useObservableLoader<T extends ObservableDataHandler<any>[]>(
 ) : DataLoader<unknown[]> {
   return useObservableLoaderConfigurable({
     observableSources,
+    // eslint-disable-next-line react-hooks/exhaustive-deps
     useOnComponentMountedHook: (onMounted: () => void) => useEffectWithSsrSupport(onMounted, dependencies),
   });
 }

templates/admin/src/lib/plume-http-react-hook-loader/timeoutHook.ts

@@ -18,14 +18,18 @@ export type TimeoutController = {
 };
 
 type TimeoutType = ReturnType<typeof setTimeout>;
+
 /**
  * This hook enables to use safely {@link setTimeout} in a component.
  * The issue using raw {@link setTimeout} is that it can resolve after the component has been unmounted...
  * This can create lots of very difficult bugs.
  *
  * This hook makes sure to stop/unregister the {@link setTimeout} when the component is being unmounted.
  * @param callback The function that will be called after {@link delayInMillis} time has passed.
+ * If the callback changes over time, the callback called after the timeout will be the changed one.
+ * If the timeout has already passed, the callback changes will have no impact.
  * @param delayInMillis The delay in milliseconds after which the {@link callback} will be executed.
+ * Delay changes after the first call will be ignored.
  *
  * This hook is a typed and commented version of
  * https://github.com/WebDevSimplified/useful-custom-react-hooks/blob/main/src/2-useTimeout/useTimeout.js
@@ -54,8 +58,6 @@ export default function useTimeout(callback: () => void, delayInMillis: number)
     return stopTimeout;
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
-  // delayInMillis is not in the dependencies. If it changes at runtime, we do not want to reset the hook.
-  // If delay can change at runtime, this hook is not the best solution to use.
 
   const restartTimeout = () => {
     stopTimeout();

templates/front/src/lib/plume-http-react-hook-loader/observableLoaderHook.ts

@@ -109,7 +109,7 @@ export function useObservableLoaderConfigurable<T extends ObservableDataHandler<
     .map((dataObservable: ObservableDataHandler<any>) => {
       // the number of observable sources is fixed and cannot change,
       // so the number of time useObservable is called will be stable
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any,react-hooks/rules-of-hooks
+      // eslint-disable-next-line react-hooks/rules-of-hooks
       const data: T = useObservable(dataObservable.dataObservable);
 
       return {
@@ -180,6 +180,7 @@ export function useObservableLoader<T extends ObservableDataHandler<any>[]>(
 ) : DataLoader<unknown[]> {
   return useObservableLoaderConfigurable({
     observableSources,
+    // eslint-disable-next-line react-hooks/exhaustive-deps
     useOnComponentMountedHook: (onMounted: () => void) => useEffectWithSsrSupport(onMounted, dependencies),
   });
 }

templates/front/src/lib/plume-http-react-hook-loader/timeoutHook.ts

@@ -26,7 +26,10 @@ type TimeoutType = ReturnType<typeof setTimeout>;
  *
  * This hook makes sure to stop/unregister the {@link setTimeout} when the component is being unmounted.
  * @param callback The function that will be called after {@link delayInMillis} time has passed.
+ * If the callback changes over time, the callback called after the timeout will be the changed one.
+ * If the timeout has already passed, the callback changes will have no impact.
  * @param delayInMillis The delay in milliseconds after which the {@link callback} will be executed.
+ * Delay changes after the first call will be ignored.
  *
  * This hook is a typed and commented version of
  * https://github.com/WebDevSimplified/useful-custom-react-hooks/blob/main/src/2-useTimeout/useTimeout.js
@@ -55,8 +58,6 @@ export default function useTimeout(callback: () => void, delayInMillis: number)
     return stopTimeout;
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
-  // delayInMillis is not in the dependencies. If it changes at runtime, we do not want to reset the hook.
-  // If delay can change at runtime, this hook is not the best solution to use.
 
   const restartTimeout = () => {
     stopTimeout();