docs(hooks): updated typescript types for hooks

issues: #22 hooks affected: - useLocalsStorage - useMediaStream - useSessionStorage
heyitsarpit · Dec 25, 2021 · 5899ed4 · 5899ed4
1 parent 3a7a952
commit 5899ed4
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/packages/core/useLocalStorage/docs.mdx b/packages/core/useLocalStorage/docs.mdx
@@ -65,7 +65,6 @@ declare type UseLocalStorageOptions = {
    */
   deserialize: (value: string) => unknown
 }
-
 /**
  * Modified `useState` hook that syncs with localStorage.
  *
@@ -79,7 +78,7 @@ declare function useLocalStorage<T>(
   key: string,
   initialValue: T,
   options?: UseLocalStorageOptions
-): [T, Dispatch<SetStateAction<T>>]
+): [T, (value: T) => void]
 ```
 
 ## Source

diff --git a/packages/core/useMediaStream/docs.mdx b/packages/core/useMediaStream/docs.mdx
@@ -171,7 +171,7 @@ declare function useMediaStream(options?: UseMediaStreamOptions): {
   stream: react.MutableRefObject<MediaStream | null>
   isPlaying: boolean
   play: () => Promise<MediaStream | null | undefined>
-  stop: () => Promise<void>
+  stop: () => void
   restart: () => Promise<MediaStream | null | undefined>
   isAudioMuted: boolean
   muteAudio: () => void

diff --git a/packages/core/useSessionStorage/docs.mdx b/packages/core/useSessionStorage/docs.mdx
@@ -65,7 +65,6 @@ declare type UseSessionStorageOptions = {
    */
   deserialize: (value: string) => unknown
 }
-
 /**
  * Modified `useState` hook that syncs with useSessionStorage.
  *
@@ -79,7 +78,7 @@ declare function useSessionStorage<T>(
   key: string,
   initialValue: T,
   options?: UseSessionStorageOptions
-): [T, Dispatch<SetStateAction<T>>]
+): [T, (value: T) => void]
 ```
 
 ## Source