feat: version 1.0.2 done - docs and exports upgrade

Author: AllanOliveiraM

README.md

@@ -41,6 +41,8 @@ To make it work like original React context, it uses
 It also requires `useContextUpdate` to behave better in Concurrent Mode.
 (You don't need to use it in Legacy Mode.)
 
+<br />
+
 ## Usage
 
 ```tsx
@@ -100,15 +102,19 @@ const App = () => (
 )
 ```
 
+---
+
 ## API
 
-### createContext
+<br />
+
+### **`createContext`**
 
 This creates a special context.
 
 #### Parameters
 
-- `defaultValue` **Value**
+- `defaultValue`: **Value**
 
 #### Examples
 
@@ -123,9 +129,13 @@ type PersonContext = {
 const PersonContext = createContext<PersonContext>({ firstName: '', familyName: '' })
 ```
 
-### Returns:
+<br />
+
+### **createContext Returns:**
 
-#### useSelector
+<br />
+
+#### `useSelector`
 
 This hook returns context selected value by selector.
 
@@ -135,7 +145,7 @@ The selector should return referentially equal result for same input for better
 
 ##### Parameters
 
-- `selector` **function (value: Value): Selected**
+- `selector`: **function (value: Value): Selected**
 
 ##### Examples
 
@@ -147,7 +157,9 @@ const MyComponent = () => {
 }
 ```
 
-#### useContext
+<br />
+
+#### `useContext`
 
 This hook returns the entire context value.
 Use this instead of React.useContext for consistent behavior.
@@ -161,7 +173,9 @@ const MyComponent = () => {
 }
 ```
 
-#### useContextUpdate
+<br />
+
+#### `useContextUpdate`
 
 This hook returns an update function that accepts a thunk function.
 
@@ -180,17 +194,43 @@ const MyComponent = () => {
 }
 ```
 
-#### BridgeProvider
+<br />
 
-This is a Provider component for bridging multiple react roots.
+#### `Provider`
+
+The provider you need to use to apply the context.
 
-#### Context
+---
 
-The special context created by createContext hook.
+<br />
 
-#### Provider
+### **Exotic Returns:**
 
-The provider you need to use to apply the context.
+You probably won't need the following features. Use only if you know what you are doing.
+
+<br />
+
+#### `Context`
+
+The special context created by createContext hook. This context should not be consumed by the ro react `useContext` API, but by `useSpecialContext` bellow.
+
+<br />
+
+#### `useSpecialContext`
+
+This Hook is used to manually consume the same special context `Context` created by `createContext` function. This is not necessary as there is a level of abstraction on top of that and this hook should only be used with contexts created by the library. This utility is only available so there are no limitations on the use of this library.
+
+<br />
+
+#### `useBridgeValue`
+
+This hook return a value for BridgeProvider.
+
+<br />
+
+#### `BridgeProvider`
+
+This is a Provider component for bridging multiple react roots.
 
 ##### Parameters
 
@@ -227,9 +267,7 @@ const App = () => {
 }
 ```
 
-#### useBridgeValue
-
-This hook return a value for BridgeProvider.
+---
 
 ## Limitations
 

package.json

@@ -8,7 +8,7 @@
     "context",
     "hooks"
   ],
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "MIT",
   "author": "AllanOliveiraM",
   "main": "./dist/index.js",
@@ -19,6 +19,7 @@
     "husky:install": "husky install",
     "precompile:native": ". automation/precompile-native.sh",
     "build": "yarn --silent precompile:native && rollup -c",
+    "build:complete": "rm -rf ./dist && yarn precompile:native && yarn build",
     "start": "yarn --silent precompile:native && rollup -c -w",
     "commit": "npx git-cz",
     "type-check": "tsc --project tsconfig.json --pretty --noEmit",

src/index.tsx

@@ -29,76 +29,104 @@ type ProviderProps<Value> = PropsWithChildren<{
  * const PersonContext = createContext<PersonContext>({ firstName: '', familyName: '' })
  */
 const createContext = <Value,>(defaultValue: Value) => {
-  /**
-   * The special context created by createContext hook.
-   */
   const Context = createContextWithSelector(defaultValue)
 
-  /**
-   * This hook returns context selected value by selector.
-   * It will trigger re-render if only the selected value is referentially changed.
-   * The selector should return referentially equal result for same input for better performance.
-   *
-   * @param selector function (value: Value): Selected
-   *
-   * @example
-   * const MyComponent = () => {
-   *  const firstName = PersonContext.useSelector(state => state.firstName)
-   *
-   *  return <p>{firstName}</p>
-   * }
-   */
   const useSelector = <Selected,>(selector: (state: Value) => Selected) =>
     useContextSelector(Context, selector)
 
-  /**
-   * This hook returns the entire context value.
-   * Use this instead of React.useContext for consistent behavior.
-   *
-   * @example
-   * const MyComponent = () => {
-   * const person = PersonContext.useContext()
-   *  ...
-   * }
-   */
   const useContext = () => useSpecialContext(Context)
 
-  /**
-   * This hook returns an update function that accepts a thunk function.
-   *
-   * Use this for a function that will change a value in
-   * [Concurrent Mode](https://reactjs.org/docs/concurrent-mode-intro.html).
-   * Otherwise, there's no need to use this hook.
-   *
-   * @example
-   * const MyComponent = () => {
-   *   const update = PersonContext.useContextUpdate()
-   *
-   *   update(() => setState(...));
-   *   ...
-   * }
-   */
   const useContextUpdate = () => useSpecialContextUpdate(Context)
 
-  /**
-   * This hook return a value for BridgeProvider.
-   */
   const useBridgeValue = () => useSpecialBridgeValue(Context)
 
-  /**
-   * The provider you need to use to apply the context.
-   */
   const Provider = ({ children, value }: ProviderProps<Value>) => (
     <Context.Provider value={value}>{children}</Context.Provider>
   )
 
   return {
+    /**
+     * This Hook is used to manually consume the same special context
+     * `Context` created by `createContext` function. This is not necessary
+     * as there is a level of abstraction on top of that and this hook should
+     * only be used with contexts created by the library. This utility is only
+     * available so there are no limitations on the use of this library.
+     */
+    useSpecialContext,
+
+    /**
+     * The special context created by createContext hook.
+     */
     Context,
+
+    /**
+     * This hook returns context selected value by selector.
+     * It will trigger re-render if only the selected value is referentially changed.
+     * The selector should return referentially equal result for same input for better performance.
+     *
+     * @param selector function (value: Value): Selected
+     *
+     * @example
+     * const MyComponent = () => {
+     *  const firstName = PersonContext.useSelector(state => state.firstName)
+     *
+     *  return <p>{firstName}</p>
+     * }
+     */
     useSelector,
+
+    /**
+     * This hook returns the entire context value.
+     * Use this instead of React.useContext for consistent behavior.
+     *
+     * @example
+     * const MyComponent = () => {
+     * const person = PersonContext.useContext()
+     *  ...
+     * }
+     */
     useContext,
+
+    /**
+     * This hook returns an update function that accepts a thunk function.
+     *
+     * Use this for a function that will change a value in
+     * [Concurrent Mode](https://reactjs.org/docs/concurrent-mode-intro.html).
+     * Otherwise, there's no need to use this hook.
+     *
+     * @example
+     * const MyComponent = () => {
+     *   const update = PersonContext.useContextUpdate()
+     *
+     *   update(() => setState(...));
+     *   ...
+     * }
+     */
     useContextUpdate,
+
+    /**
+     * This hook return a value for BridgeProvider.
+     */
     useBridgeValue,
+
+    /**
+     * The provider you need to use to apply the context.
+     */
     Provider,
+
+    /**
+     * This is a Provider component for bridging multiple react roots
+     *
+     * @example
+     * const valueToBridge = useBridgeValue(PersonContext);
+     * return (
+     *   <Renderer>
+     *     <BridgeProvider context={Context} value={valueToBridge}>
+     *       {children}
+     *     </BridgeProvider>
+     *   </Renderer>
+     * );
+     */
     BridgeProvider,
   }
 }

tsconfig.json

@@ -15,6 +15,7 @@
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "isolatedModules": true,
+    "removeComments": false,
     "jsx": "react-jsx"
   },
   "include": ["src/**/*.ts*"],