use-good-hooks 1.0.8 → 1.0.10

package/README.md

@@ -35,7 +35,7 @@ Debounces value changes to prevent rapid updates. Useful for search inputs, form
 ```typescript
 import { useDebounce } from 'use-good-hooks';
 
-function SearchComponent() {
+const SearchComponent = () => {
   const [searchTerm, setSearchTerm] = useState('');
   const debouncedSearchTerm = useDebounce(searchTerm, 500); // 500ms delay
 
@@ -54,7 +54,7 @@ function SearchComponent() {
       placeholder="Search..."
     />
   );
-}
+};
 ```
 
 #### Parameters
@@ -73,7 +73,7 @@ Limits the rate at which a value can update. Useful for scroll events, window re
 ```typescript
 import { useThrottle } from 'use-good-hooks';
 
-function ScrollTracker() {
+const ScrollTracker = () => {
   const [scrollY, setScrollY] = useState(0);
   const throttledScrollY = useThrottle(scrollY, 200); // 200ms throttle
 
@@ -87,7 +87,7 @@ function ScrollTracker() {
   }, []);
 
   return <div>Throttled scroll position: {throttledScrollY}px</div>;
-}
+};
 ```
 
 #### Parameters
@@ -106,7 +106,7 @@ Captures the previous value of a state or prop. Useful for comparing changes bet
 ```typescript
 import { usePrev } from 'use-good-hooks';
 
-function Counter({ count }) {
+const Counter = ({ count }) => {
   const prevCount = usePrev(count);
 
   return (
@@ -116,7 +116,7 @@ function Counter({ count }) {
       <p>Direction: {count > prevCount ? 'Increasing' : count < prevCount ? 'Decreasing' : 'No change'}</p>
     </div>
   );
-}
+};
 ```
 
 #### Parameters
@@ -134,7 +134,7 @@ Detects distinct changes in values with support for deep comparison and custom e
 ```typescript
 import { useDistinct } from 'use-good-hooks';
 
-function UserProfileForm({ user }) {
+const UserProfileForm = ({ user }) => {
   const { distinct, value, prevValue } = useDistinct(user, { deep: true });
 
   useEffect(() => {
@@ -151,7 +151,7 @@ function UserProfileForm({ user }) {
       {/* Form inputs */}
     </div>
   );
-}
+};
 ```
 
 #### Parameters
@@ -176,7 +176,7 @@ Persists state to localStorage or sessionStorage with automatic serialization/de
 ```typescript
 import { useStorageState } from 'use-good-hooks';
 
-function ThemePreferences() {
+const ThemePreferences = () => {
   const [preferences, setPreferences, { removeKey }] = useStorageState('theme-prefs', {
     darkMode: false,
     fontSize: 'medium',
@@ -198,7 +198,7 @@ function ThemePreferences() {
       <button onClick={removeKey}>Reset to Defaults</button>
     </div>
   );
-}
+};
 ```
 
 #### Parameters
@@ -227,7 +227,7 @@ Synchronizes state with URL query parameters. Great for shareable UI states, fil
 ```typescript
 import { useUrlState } from 'use-good-hooks';
 
-function ProductFilter() {
+const ProductFilter = () => {
   const [filters, setFilters] = useUrlState({
     category: '',
     minPrice: 0,
@@ -252,7 +252,7 @@ function ProductFilter() {
       {/* More filter controls */}
     </div>
   );
-}
+};
 ```
 
 #### Parameters

package/dist/index.d.ts

@@ -1,20 +1,56 @@
-import { default as useDebounce } from './hooks/use-debounce';
-import { default as useDistinct } from './hooks/use-distinct';
-import { default as usePrev } from './hooks/use-prev';
-import { default as useStorageState } from './hooks/use-storage-state';
-import { default as useThrottle } from './hooks/use-throttle';
-import { default as useUrlState } from './hooks/use-url-state';
+declare type SetUrlStateAction<T> = T | ((prevState: T) => T);
 
-export { useDebounce }
+declare type StorageType = 'local' | 'session';
 
-export { useDistinct }
+declare type StrictObject = {
+    [key: string]: any;
+} & {
+    length?: never;
+};
 
-export { usePrev }
+export declare const useDebounce: <T>(value: T, delay?: number) => T;
 
-export { useStorageState }
+export declare const useDistinct: <T>(inputValue: T, options?: UseDistinctOptions) => UseDistinctReturn<T>;
 
-export { useThrottle }
+declare type UseDistinctOptions = {
+    compare?: (a: any, b: any) => boolean;
+    debounce?: number;
+    deep?: boolean;
+};
 
-export { useUrlState }
+declare type UseDistinctReturn<T> = {
+    distinct: boolean;
+    prevValue: T | undefined;
+    value: T;
+};
+
+export declare const usePrev: <T>(value: T) => T | undefined;
+
+export declare const useStorageState: <T extends StrictObject>(key: string, initialState: T, options?: UseStorageStateOptions) => [T, (value: T | ((prev: T) => T)) => void, {
+    removeKey: () => void;
+}];
+
+declare type UseStorageStateOptions = {
+    debounce?: number;
+    onError?: (err: Error) => void;
+    omitKeys?: string[] | ((value: any, key: string) => boolean);
+    pickKeys?: string[] | ((value: any, key: string) => boolean);
+    storage?: StorageType;
+};
+
+export declare const useThrottle: <T>(value: T, delay?: number) => T;
+
+export declare const useUrlState: <T extends StrictObject>(initialState: T, options: UseUrlStateOptions) => [T, (value: SetUrlStateAction<T>) => void];
+
+declare type UseUrlStateOptions = {
+    debounce?: number;
+    kebabCase?: boolean;
+    omitKeys?: string[] | ((value: any, key: string) => boolean);
+    omitValues?: any[] | ((value: any, key: string) => boolean);
+    onError?: (err: Error) => void;
+    pickKeys?: string[] | ((value: any, key: string) => boolean);
+    prefix?: string;
+    url: URL;
+};
 
 export { }

package/package.json

@@ -41,10 +41,9 @@
 	},
 	"scripts": {
 		"build": "yarn lint && vite build --mode export",
-		"dev": "vite",
 		"lint": "prettier --write . && eslint .",
 		"npm-publish": "yarn test --run && yarn build && yarn version --patch --no-git-tag-version && yarn publish --non-interactive",
 		"test": "vitest"
 	},
-	"version": "1.0.8"
+	"version": "1.0.10"
 }