@webkrafters/react-observable-context 2.0.0 → 2.0.1

package/README.md

@@ -16,7 +16,7 @@ The React-Observable-Context package exports **3** modules namely: the **createC
 
 * **createContext** is a zero-parameter funtion returning a store-bearing context. Pass the context to the React::useContext() parameter to obtain the context's `store`.
 
-* **useContext** is analogous to React::useContext hook but returns the context store and takes a second parameter named ***watchedKeys***. The `watchedKeys` parameter is a list of state object property names to watch. Change in any of the referenced properties automatically triggers a render of the component calling this hook.  
+* **useContext** is analogous to React::useContext hook but returns the context store and takes a second parameter named ***watchedKeys***. The `watchedKeys` parameter is a list of state object property paths to watch. A change in any of the referenced properties automatically triggers a render of the component calling this hook.
 
 * **Provider** can immediately be used as-is anywhere the React-Observable-Context is required. It accepts **3** props and the customary Provider `children` prop. Supply the context to its `context` prop; the initial state to the customary Provider `value` prop; and the optional `prehooks` prop <i>(discussed in the prehooks section below)</i>.
 
@@ -30,7 +30,7 @@ The context's `store` exposes **4** methods for interacting with the context's i
 
 * **resetState**: VoidFunction // resets the state to the Provider initial `value` prop.
 
-* **setState**: (changes: PartialState\<State\>) => void
+* **setState**: (changes: PartialState\<State\>) => void // sets only new/changed top level properties.
 
 * **subscribe**: (listener: (newValue: PartialState\<State\>, oldValue: PartialState\<State\>) => void) => ***UnsubscribeFunction***
 

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export class UsageError extends Error {
 }
 export function createContext<T_1 extends State>(): React.Context<Store<T_2>>;
-export function useContext<T_1 extends State>(context: React.Context<Store<T_2>>, watchedKeys?: (keyof T_1)[]): Store<T_1>;
+export function useContext<T_1 extends State>(context: React.Context<Store<T_2>>, watchedKeys?: (string | keyof T_1)[]): Store<T_1>;
 /**
  * Note: `context` prop is not updateable. Furtther updates to this prop are ignored.
  *

package/dist/index.js

@@ -72,13 +72,14 @@ var createContext = function createContext() {
  * Actively monitors the store and triggers component re-render if any of the watched keys in the state objects changes
  *
  * @param {ObservableContext<T>} context
- * @param {Array<keyof T>} [watchedKeys = []] Names of state properties to watch. A change in any of the referenced properties results in this component render.
+ * @param {Array<string|keyof T>} [watchedKeys = []] A list of state object property paths to watch. A change in any of the referenced properties results in this component render.
  * @returns {Store<T>}
  * @template {State} T
  */
 exports.createContext = createContext;
 var useContext = function useContext(context) {
   var watchedKeys = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  /** @type {Store<T>} */
   var store = (0, _react.useContext)(context);
   var _useState = (0, _react.useState)(false),
     _useState2 = _slicedToArray(_useState, 2),

package/package.json

@@ -76,5 +76,5 @@
     "test:watch": "eslint --fix && jest --watchAll"
   },
   "types": "dist/index.d.ts",
-  "version": "2.0.0"
+  "version": "2.0.1"
 }