common-hook
Version:
提供项目中常用的 React Hooks
25 lines (24 loc) • 1.09 kB
TypeScript
export * from "./useBoolean";
export * from "./useDebounce";
export * from "./useRafState";
export * from "./useSetState";
export * from "./useThrottle";
export * from "./useToggle";
/**
* @name 状态 Hooks
* @example
* useSetState // 管理 object 类型 state 的 Hooks
* useBoolean // 切换boolean,可以接收默认值
* useToggle // 用于在两个状态值间切换Hook
* useDebounce // 处理防抖值Hook
* useThrottle // 处理节流值Hook
* useRafState // 只在 requestAnimationFrame callback 时更新 state
*/
export declare const State: {
useBoolean: (defaultValue?: boolean) => any[];
useDebounce: (value: any, options?: any) => any;
useRafState: <S>(initialState?: S | (() => S)) => readonly [any, any];
useSetState: <S extends Record<string, any>>(initialState: S | (() => S)) => [S, <K extends keyof S>(state: Pick<S, K> | ((prevState: Readonly<S>) => S | Pick<S, K> | null) | null) => void];
useThrottle: <T>(value: T, options?: any) => any;
useToggle: <D, R>(defaultValue?: D, reverseValue?: R) => any[];
};