Skip to content

refactor(types): remove unnecessary declare module block #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor(types): remove unnecessary declare module block #336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 104 additions & 106 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,148 +116,146 @@ export type SpeechState = {
volume: number;
};

declare module "@uidotdev/usehooks" {
export function useBattery(): BatteryManager;
export function useBattery(): BatteryManager;

export function useClickAway<T extends Element>(
cb: (e: Event) => void
): React.MutableRefObject<T>;
export function useClickAway<T extends Element>(
cb: (e: Event) => void
): React.MutableRefObject<T>;

export function useCopyToClipboard(): [
string | null,
(value: string) => Promise<void>
];
export function useCopyToClipboard(): [
string | null,
(value: string) => Promise<void>
];

export function useCounter(
startingValue?: number,
options?: {
min?: number;
max?: number;
}
): [
number,
{
increment: () => void;
decrement: () => void;
set: (nextCount: number) => void;
reset: () => void;
}
];
export function useCounter(
startingValue?: number,
options?: {
min?: number;
max?: number;
}
): [
number,
{
increment: () => void;
decrement: () => void;
set: (nextCount: number) => void;
reset: () => void;
}
];

export function useDebounce<T>(value: T, delay: number): T;
export function useDebounce<T>(value: T, delay: number): T;

export function useDefault<T>(
initialValue: T,
defaultValue: T
): [T, React.Dispatch<React.SetStateAction<T>>];
export function useDefault<T>(
initialValue: T,
defaultValue: T
): [T, React.Dispatch<React.SetStateAction<T>>];

export function useDocumentTitle(title: string): void;
export function useDocumentTitle(title: string): void;

export function useFavicon(url: string): void;
export function useFavicon(url: string): void;

export function useGeolocation(options?: PositionOptions): GeolocationState;
export function useGeolocation(options?: PositionOptions): GeolocationState;

export function useHistoryState<T>(initialPresent?: T): HistoryState<T>;
export function useHistoryState<T>(initialPresent?: T): HistoryState<T>;

export function useHover<T extends Element>(): [
React.RefCallback<T>,
boolean
];
export function useHover<T extends Element>(): [
React.RefCallback<T>,
boolean
];

export function useIdle(ms?: number): boolean;
export function useIdle(ms?: number): boolean;

export function useIntersectionObserver<T extends Element>(
options?: IntersectionObserverInit
): [React.RefCallback<T>, IntersectionObserverEntry | null];
export function useIntersectionObserver<T extends Element>(
options?: IntersectionObserverInit
): [React.RefCallback<T>, IntersectionObserverEntry | null];

export function useIsClient(): boolean;
export function useIsClient(): boolean;

export function useIsFirstRender(): boolean;
export function useIsFirstRender(): boolean;

export function useList<T>(defaultList?: T[]): [T[], CustomList<T>];
export function useList<T>(defaultList?: T[]): [T[], CustomList<T>];

export function useLocalStorage<T>(
key: string,
initialValue?: T
): [T, React.Dispatch<React.SetStateAction<T>>];
export function useLocalStorage<T>(
key: string,
initialValue?: T
): [T, React.Dispatch<React.SetStateAction<T>>];

export function useLockBodyScroll(): void;
export function useLockBodyScroll(): void;

export function useLongPress(
callback: (e: Event) => void,
options?: LongPressOptions
): LongPressFns;
export function useLongPress(
callback: (e: Event) => void,
options?: LongPressOptions
): LongPressFns;

export function useMap<T>(initialState?: T): Map<T, any>;
export function useMap<T>(initialState?: T): Map<T, any>;

export function useMeasure<T extends Element>(): [
React.RefCallback<T>,
{
width: number | null;
height: number | null;
}
];
export function useMeasure<T extends Element>(): [
React.RefCallback<T>,
{
width: number | null;
height: number | null;
}
];

export function useMediaQuery(query: string): boolean;
export function useMediaQuery(query: string): boolean;

export function useMouse<T extends Element>(): [
MousePosition,
React.MutableRefObject<T>
];
export function useMouse<T extends Element>(): [
MousePosition,
React.MutableRefObject<T>
];

export function useNetworkState(): NetworkState;
export function useNetworkState(): NetworkState;

export function useObjectState<T>(initialValue: T): [T, (arg: T) => void];
export function useObjectState<T>(initialValue: T): [T, (arg: T) => void];

export function useOrientation(): {
angle: number;
type: string;
};
export function useOrientation(): {
angle: number;
type: string;
};

export function usePreferredLanguage(): string;
export function usePreferredLanguage(): string;

export function usePrevious<T>(newValue: T): T;
export function usePrevious<T>(newValue: T): T;

export function useQueue<T>(initialValue?: T[]): CustomQueue<T>;
export function useQueue<T>(initialValue?: T[]): CustomQueue<T>;

export function useRenderCount(): number;
export function useRenderCount(): number;

export function useRenderInfo(name?: string): RenderInfo | undefined;
export function useRenderInfo(name?: string): RenderInfo | undefined;

export function useScript(
src: string,
options?: {
removeOnUnmount?: boolean;
}
): "unknown" | "loading" | "ready" | "error";
export function useScript(
src: string,
options?: {
removeOnUnmount?: boolean;
}
): "unknown" | "loading" | "ready" | "error";

export function useSessionStorage<T>(
key: string,
initialValue: T
): [T, React.Dispatch<React.SetStateAction<T>>];
export function useSessionStorage<T>(
key: string,
initialValue: T
): [T, React.Dispatch<React.SetStateAction<T>>];

export function useSet<T>(values?: T[]): Set<T>;
export function useSet<T>(values?: T[]): Set<T>;

export function useSpeech(text: string, options?: SpeechOptions): SpeechState;
export function useSpeech(text: string, options?: SpeechOptions): SpeechState;

export function useThrottle<T>(value: T, delay: number): T;
export function useThrottle<T>(value: T, delay: number): T;

export function useToggle(
initialValue?: boolean
): [boolean, (newValue?: boolean) => void];
export function useToggle(
initialValue?: boolean
): [boolean, (newValue?: boolean) => void];

export function useVisibilityChange(): boolean;
export function useVisibilityChange(): boolean;

export function useWindowScroll(): [
{
x: number | null;
y: number | null;
},
(args: unknown) => void
];
export function useWindowScroll(): [
{
x: number | null;
y: number | null;
},
(args: unknown) => void
];

export function useWindowSize(): {
width: number | null;
height: number | null;
};
}
export function useWindowSize(): {
width: number | null;
height: number | null;
};