@bigbinary/neeto-commons-frontend 2.0.60 → 2.0.62

package/react-utils.d.ts

@@ -134,6 +134,48 @@ export function copyToClipboard(text: string, configs?: {
  * @endexample
 */
 export function buildUrl(route: string, params: object): string;
+type TimerType = {
+  lastUpdated: number;
+  interval: number;
+};
+/**
+ *
+ * The useTimer hook re-renders in the specified time interval. This can
+ *
+ * auto-update the rendered elapsed time in components without requiring the
+ *
+ * application to be manually refreshed.
+ *
+ * This hook accepts a single argument timerIntervalInSeconds, which is the
+ *
+ * number of seconds after which the component will re-render. The default value is
+ *
+ * 60 seconds.
+ *
+ * All invocations of useTimer hooks are attached to a single setInterval call
+ *
+ * which ticks every 1 second. So using that hook in multiple components won't
+ *
+ * cause any performance drop.
+ *
+ * Note that the maximum precision for useTimer hook is one second. In other
+ *
+ * words, there is a possibility that your component will take at most one more
+ *
+ * second than the scheduled time interval to re-render.
+ *
+ * @example 
+ *
+ * import { useTimer } from "neetocommons/react-utils";
+ * 
+ * const Component = () => {
+ *   useTimer(timerIntervalInSeconds);
+ * 
+ *   // Rest of the component
+ * };
+ * @endexample
+*/
+export function useTimer(interval: number): TimerType;
 type DateTimeType = string | number | dayjs.Dayjs | Date | null | undefined;
 export const timeFormat: {
   fromNow: (time: DateTimeType) => string;