@indot/react-ctx-store/dist/ctx.d.ts

Custom hook factory for context providers/consumers

/**
 * ctx.tsx
 *
 * @description Creates a context hook and provider.
 *
 * @author jasmith79@gmail.com
 * @license MIT
 */
import { ReactNode, FunctionComponent } from 'react';
import { IPojo } from '@jasmith79/ts-utils';
declare type Reducer<S, A> = (prevState: S, action: A) => S;
declare type Dispatch<A> = (action: A) => void;
declare type GenericReducerAction = {
    type: string;
};
declare type ContextParams<S, A> = [S, Dispatch<A>];
export interface ContextProviderProps<S extends {}, A> {
    initialState?: S;
    reducer: Reducer<S, A>;
    children: ReactNode;
}
interface ContextProvider<T> extends FunctionComponent<T> {
    propTypes: any;
    defaultProps: any;
}
declare const _default: <S extends IPojo, A = GenericReducerAction>(initialData?: S) => [() => ContextParams<S, A>, ContextProvider<ContextProviderProps<S, A>>];
/**
 * @description Utility function to create the hook and provider.
 *
 * @typeparam S The generic stand in for the state type of the reducer state.
 * @typeparam A The generic stand in for the action type of the action fed to dispatch.
 * @returns {Array} A tuple of the use hook and context provider.
 */
export default _default;