mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
edb4917e1b
* [use-global-hook] Updates def for simpler usage * [use-global-hook] make recommended changes * [use-global-hook] remove lint suppression
36 lines
1.2 KiB
TypeScript
36 lines
1.2 KiB
TypeScript
// Type definitions for use-global-hook 0.1
|
|
// Project: https://github.com/andregardi/use-global-hook#readme
|
|
// Definitions by: James Hong <https://github.com/ojameso>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 3.6
|
|
|
|
// Use an interface so that different versions of React can be used
|
|
interface ReactInterface {
|
|
useEffect: (...args: any[]) => any;
|
|
useState: (...args: any[]) => any;
|
|
useMemo: (...args: any[]) => any;
|
|
}
|
|
// to ignore strict-export-declare-modifiers error
|
|
export {};
|
|
|
|
// Where S is typeof state and A is typeof associated actions
|
|
export interface Store<S, A> {
|
|
state: S;
|
|
actions: A;
|
|
setState(state: S, afterUpdateCallback?: () => void): void;
|
|
}
|
|
|
|
export type InitializerFunction<S, A> = (store: Store<S, A>) => void;
|
|
|
|
type UseGlobal<S, A> = (() => [S, A]) &
|
|
(<NS>(stateFunc: (state: S) => NS) => [NS, A]) &
|
|
(<NS, NA>(stateFunc: (state: S) => NS, actionsFunc: (state: A) => NA) => [NS, NA]) &
|
|
(<NA>(stateFunc: undefined, actionsFunc: (state: A) => NA) => [S, NA]);
|
|
|
|
export default function useStore<S, A>(
|
|
React: ReactInterface,
|
|
inititalState: S,
|
|
actions: object,
|
|
initializers?: InitializerFunction<S, A>,
|
|
): UseGlobal<S, A>;
|