Functions
createContext
- createContext<S, A>(options: IContextOptions<S, A>): { Consumer: Consumer<[S, Dispatch<A>]>; Context: Context<[S, Dispatch<A>]>; Provider: (__namedParameters: IProvider<S, A>) => Element }
-
Type parameters
Parameters
Returns { Consumer: Consumer<[S, Dispatch<A>]>; Context: Context<[S, Dispatch<A>]>; Provider: (__namedParameters: IProvider<S, A>) => Element }
-
Consumer: Consumer<[S, Dispatch<A>]>
-
Context: Context<[S, Dispatch<A>]>
-
Provider: (__namedParameters: IProvider<S, A>) => Element
-
- (__namedParameters: IProvider<S, A>): Element
-
Parameters
Returns Element
createRestash
- createRestash<S, U>(options?: IRestashOptions<S, U>): { Consumer: Consumer<[State, Dispatch<IRestashAction<"data", any>>]>; Context: Context<[State, Dispatch<IRestashAction<"data", any>>]>; Provider: (__namedParameters: IProvider<State, IRestashAction<"data", any>>) => Element; clearPersistence: <K>(...keys: K[]) => boolean; useStore: { <K>(key: K, value?: any): RestashHook<PathValue<S, K>, U>; (): RestashHook<S, U> } }
-
Type parameters
-
S: Record<string, any>
-
U: string = "start" | "progress" | "error" | "complete"
Parameters
Returns { Consumer: Consumer<[State, Dispatch<IRestashAction<"data", any>>]>; Context: Context<[State, Dispatch<IRestashAction<"data", any>>]>; Provider: (__namedParameters: IProvider<State, IRestashAction<"data", any>>) => Element; clearPersistence: <K>(...keys: K[]) => boolean; useStore: { <K>(key: K, value?: any): RestashHook<PathValue<S, K>, U>; (): RestashHook<S, U> } }
-
Consumer: Consumer<[State, Dispatch<IRestashAction<"data", any>>]>
-
Context: Context<[State, Dispatch<IRestashAction<"data", any>>]>
-
Provider: (__namedParameters: IProvider<State, IRestashAction<"data", any>>) => Element
-
-
Parameters
Returns Element
-
clearPersistence: <K>(...keys: K[]) => boolean
-
- <K>(...keys: K[]): boolean
-
Type parameters
Parameters
Returns boolean
-
useStore: { <K>(key: K, value?: any): RestashHook<PathValue<S, K>, U>; (): RestashHook<S, U> }
-
-
Type parameters
-
K: string | number | symbol | `${string}.${string}`
Parameters
-
key: K
-
Optional value: any
-
createStore
- createStore<S, A>(options?: IStoreOptions<S, A>): { Consumer: Consumer<[S, Dispatch<A>]>; Context: Context<[S, Dispatch<A>]>; Provider: (__namedParameters: IProvider<S, A>) => Element; useStore: () => [S, Dispatch<A>] }
-
Type parameters
Parameters
Returns { Consumer: Consumer<[S, Dispatch<A>]>; Context: Context<[S, Dispatch<A>]>; Provider: (__namedParameters: IProvider<S, A>) => Element; useStore: () => [S, Dispatch<A>] }
-
Consumer: Consumer<[S, Dispatch<A>]>
-
Context: Context<[S, Dispatch<A>]>
-
Provider: (__namedParameters: IProvider<S, A>) => Element
-
- (__namedParameters: IProvider<S, A>): Element
-
Parameters
Returns Element
-
useStore: () => [S, Dispatch<A>]
Applies middleware wrapping for dispatch