add DefaultedStateObservable overloads

Author: voliva

packages/core/src/bind/index.ts

@@ -3,14 +3,12 @@ import { SUSPENSE } from "../SUSPENSE"
 import connectFactoryObservable from "./connectFactoryObservable"
 import connectObservable from "./connectObservable"
 import { EMPTY_VALUE } from "../internal/empty-value"
-import { StateObservable } from "@josepot/rxjs-state"
+import { StateObservable, DefaultedStateObservable } from "@josepot/rxjs-state"
 
 /**
  * Binds an observable to React
  *
  * @param {Observable<T>} observable - Source observable to be used by the hook.
- * @param {T} [defaultValue] - Default value that will be used if the observable
- * has not emitted any values.
  * @returns [1, 2]
  * 1. A React Hook that yields the latest emitted value of the observable
  * 2. A `sharedLatest` version of the observable. It can be used for composing
@@ -23,16 +21,30 @@ import { StateObservable } from "@josepot/rxjs-state"
  */
 export function bind<T>(
   observable: Observable<T>,
-  defaultValue?: T,
 ): [() => Exclude<T, typeof SUSPENSE>, StateObservable<T>]
 
+/**
+ * Binds an observable to React
+ *
+ * @param {Observable<T>} observable - Source observable to be used by the hook.
+ * @param {T} defaultValue - Default value that will be used if the observable
+ * has not emitted any values.
+ * @returns [1, 2]
+ * 1. A React Hook that yields the latest emitted value of the observable
+ * 2. A `sharedLatest` version of the observable. It can be used for composing
+ * other streams that depend on it. The shared subscription is closed as soon as
+ * there are no subscribers to that observable.
+ */
+export function bind<T>(
+  observable: Observable<T>,
+  defaultValue: T,
+): [() => Exclude<T, typeof SUSPENSE>, DefaultedStateObservable<T>]
+
 /**
  * Binds a factory observable to React
  *
- * @param getObservable - Factory of observables. The arguments of this function
+ * @param {(...args: any) => Observable<T>} getObservable - Factory of observables. The arguments of this function
  *  will be the ones used in the hook.
- * @param [defaultValue] - Function or value that will be used of the observable
- * has not emitted.
  * @returns [1, 2]
  * 1. A React Hook function with the same parameters as the factory function.
  *  This hook will yield the latest update from the observable returned from
@@ -48,13 +60,36 @@ export function bind<T>(
  */
 export function bind<A extends unknown[], O>(
   getObservable: (...args: A) => Observable<O>,
-  defaultValue?: O | ((...args: A) => O),
 ): [
   (...args: A) => Exclude<O, typeof SUSPENSE>,
   (...args: A) => StateObservable<O>,
 ]
 
-export function bind(observable: any, defaultValue: any) {
+/**
+ * Binds a factory observable to React
+ *
+ * @param {(...args: any) => Observable<T>} getObservable - Factory of observables. The arguments of this function
+ *  will be the ones used in the hook.
+ * @param {T} defaultValue - Function or value that will be used of the observable
+ * has not emitted.
+ * @returns [1, 2]
+ * 1. A React Hook function with the same parameters as the factory function.
+ *  This hook will yield the latest update from the observable returned from
+ *  the factory function.
+ * 2. A `sharedLatest` version of the observable generated by the factory
+ *  function that can be used for composing other streams that depend on it.
+ *  The shared subscription is closed as soon as there are no subscribers to
+ *  that observable.
+ */
+export function bind<A extends unknown[], O>(
+  getObservable: (...args: A) => Observable<O>,
+  defaultValue: O | ((...args: A) => O),
+): [
+  (...args: A) => Exclude<O, typeof SUSPENSE>,
+  (...args: A) => DefaultedStateObservable<O>,
+]
+
+export function bind(observable: any, defaultValue?: any) {
   return (
     typeof observable === "function"
       ? (connectFactoryObservable as any)