28 lines
1.1 KiB
TypeScript
28 lines
1.1 KiB
TypeScript
|
/// <reference types="react" />
|
||
|
|
import type { ReactReduxContextValue } from '../components/Context';
|
||
|
|
/**
|
||
|
|
* Hook factory, which creates a `useReduxContext` hook bound to a given context. This is a low-level
|
||
|
|
* hook that you should usually not need to call directly.
|
||
|
|
*
|
||
|
|
* @param {React.Context} [context=ReactReduxContext] Context passed to your `<Provider>`.
|
||
|
|
* @returns {Function} A `useReduxContext` hook bound to the specified context.
|
||
|
|
*/
|
||
|
|
export declare function createReduxContextHook(context?: import("react").Context<ReactReduxContextValue<any, import("redux").AnyAction>>): () => ReactReduxContextValue | null;
|
||
|
|
/**
|
||
|
|
* A hook to access the value of the `ReactReduxContext`. This is a low-level
|
||
|
|
* hook that you should usually not need to call directly.
|
||
|
|
*
|
||
|
|
* @returns {any} the value of the `ReactReduxContext`
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
*
|
||
|
|
* import React from 'react'
|
||
|
|
* import { useReduxContext } from 'react-redux'
|
||
|
|
*
|
||
|
|
* export const CounterComponent = () => {
|
||
|
|
* const { store } = useReduxContext()
|
||
|
|
* return <div>{store.getState()}</div>
|
||
|
|
* }
|
||
|
|
*/
|
||
|
|
export declare const useReduxContext: () => ReactReduxContextValue | null;
|