feat: 🎸 improve useObservable() type annotations

streamich · May 30, 2019 · d0c3713 · d0c3713
1 parent 70697d9
commit d0c3713
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/src/useObservable.ts b/src/useObservable.ts
@@ -1,6 +1,16 @@
 import { useEffect, useState } from 'react';
 
-const useObservable = <T>(observable$, initialValue?: T): T | undefined => {
+export interface Observable<T> {
+  subscribe: (
+    listener: (value: T) => void
+  ) => {
+    unsubscribe: () => void;
+  };
+}
+
+function useObservable<T>(observable$: Observable<T>): T | undefined;
+function useObservable<T>(observable$: Observable<T>, initialValue: T): T;
+function useObservable<T>(observable$: Observable<T>, initialValue?: T): T | undefined {
   const [value, update] = useState<T | undefined>(initialValue);
 
   useEffect(() => {
@@ -9,6 +19,6 @@ const useObservable = <T>(observable$, initialValue?: T): T | undefined => {
   }, [observable$]);
 
   return value;
-};
+}
 
 export default useObservable;