🔨 Update hook args + docs

Author: danieldelcore

README.md

@@ -35,8 +35,9 @@ A **development only** hook, which increments state over a predefined interval,
 
 **Arguments:**
 
--   timeout: `Number` Timeout between rerenders
--   shouldLog: `Bool` Emit a warning log on rerender
+-   args: `Object`
+    -   timeout: `Number` Timeout between rerenders
+    -   shouldLog: `Bool` Emit a warning log on rerender
 
 **Returns:**
 

src/index.ts

@@ -1,2 +1,5 @@
-export { default as useStableRefTester } from './useStableRefTester';
+export {
+    default as useStableRefTester,
+    UseStableRefTesterArgs,
+} from './useStableRefTester';
 export { default as useWhichDepChanged } from './useWhichDepChanged';

src/useStableRefTester.tsx

@@ -1,9 +1,14 @@
 import { useState, useEffect } from 'react';
 
-export const useStableRefTester = (
-    timeout: number = 1000,
-    shouldLog: boolean = false,
-) => {
+export interface UseStableRefTesterArgs {
+    timeout: number;
+    shouldLog: boolean;
+}
+
+export const useStableRefTester = ({
+    timeout = 1000,
+    shouldLog = false,
+}: UseStableRefTesterArgs) => {
     if ((process.env.NODE_ENV = 'production')) {
         console.warn(
             'useStableRefTester is only intended for development purposes only. Please remove from production bundles.',