use-good-hooks 1.0.0 → 1.0.2

package/README.md

@@ -340,4 +340,3 @@ MIT © [Felipe Rohde](mailto:feliperohdee@gmail.com)
 - Twitter: [@felipe_rohde](https://twitter.com/felipe_rohde)
 - Github: [@feliperohdee](https://github.com/feliperohdee)
 - Email: feliperohdee@gmail.com
-

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+declare type SetUrlStateAction<T> = T | ((prevState: T) => T);
+
+declare type StorageType = 'local' | 'session';
+
+declare type StrictObject = {
+    [key: string]: any;
+} & {
+    length?: never;
+};
+
+export declare const useDebounce: <T>(value: T, delay?: number) => T;
+
+export declare const useDistinct: <T>(inputValue: T, options?: UseDistinctOptions) => UseDistinctReturn<T>;
+
+declare type UseDistinctOptions = {
+    compare?: (a: any, b: any) => boolean;
+    debounce?: number;
+    deep?: boolean;
+};
+
+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 { }