update typedoc

Author: avkonst

dist/index.d.ts

@@ -140,7 +140,14 @@ export interface StateMethods<S> {
      * ```
      */
     readonly value: S;
+    /**
+     * True if state value is not yet available (eg. equal to a promise)
+     */
     readonly promised: boolean;
+    /**
+     * If a state was set to a promise and the promise was rejected,
+     * this property will return the error captured from the promise rejection
+     */
     readonly error: StateErrorAtRoot | undefined;
     /**
      * Unwraps and returns the underlying state value referred by
@@ -176,24 +183,26 @@ export interface StateMethods<S> {
      * value with the argument converted to string and sets the result to the state.
      */
     merge(newValue: SetPartialStateAction<S>): void;
-    nested<K extends keyof S>(key: K): State<S[K]>;
     /**
-     * Maps this state to the result via the provided action.
-     *
-     * @param action mapper function
+     * Returns nested state by key.
+     * `state.nested('myprop')` returns the same as `state.myprop` or `state['myprop']`,
+     * but also works for properties, which names collide with names of state methods.
      *
-     * @param onPromised this will be invoked instead of the action function,
-     * if a state value is unresolved promise.
-     * [Learn more about async states...](https://hookstate.js.org/docs/asynchronous-state)
+     * [Learn more about nested states...](https://hookstate.js.org/docs/nested-state)
      *
-     * @param onError this will be invoked instead of the action function,
-     * if a state value is a promise resolved to an error.
-     * [Learn more about async states...](https://hookstate.js.org/docs/asynchronous-state)
+     * @param key child property name or index
+     */
+    nested<K extends keyof S>(key: K): State<S[K]>;
+    /**
+     * Runs the provided action callback with optimised re-rendering.
+     * Updating state within a batch action does not trigger immediate rerendering.
+     * Instead, all required rerendering is done once the batch is finished.
      *
-     * @param context if specified, the callbacks will be invoked in a batch.
-     * Updating state within a batch does not trigger immediate rerendering.
-     * Instead, all required rerendering is done once once the batch is finished.
      * [Learn more about batching...](https://hookstate.js.org/docs/performance-batched-updates
+     *
+     * @param action callback function to execute in a batch
+     *
+     * @param context custom user's value, which is passed to plugins
      */
     batch<R, C>(action: (s: State<S>) => R, context?: Exclude<C, Function>): R;
     /**