chore: add better typedocs

src/index.tsx

@@ -3,24 +3,58 @@
 import React from "react";
 import { silence } from "./lib/contants";
 
+/**
+ * React context for managing audio playback, including playing, stopping, and resuming audio tracks.
+ * This context provides a way to control audio playback and track the current playing audio.
+ */
 interface NowPlayingContext extends Partial<Omit<HTMLAudioElement, "play">> {
+  /**
+   * The HTMLAudioElement being used for playback.
+   */
   player: HTMLAudioElement | undefined;
+
+  /**
+   * Plays the given audio. If the audio is not a string, it will be converted to a blob URL.
+   * @param audio The audio source to play. Can be a MediaSource, Blob, or a string URL.
+   * @param type The MIME type of the audio. Defaults to "audio/mp3".
+   * @param uid An optional unique identifier for the audio source.
+   * @returns A promise that resolves when the audio starts playing.
+   */
   play: (
     audio: MediaSource | Blob | string,
     type?: string,
     uid?: string
   ) => Promise<void>;
+
+  /**
+   * Resumes audio playback from the current position.
+   */
   resume: () => void;
+
+  /**
+   * Stops the audio playback and resets the player's currentTime to 0.
+   */
   stop: () => void;
+
+  /**
+   * An optional unique identifier for the currently playing audio source.
+   */
   uid: string | undefined;
 }
 
+/**
+ * Props for the NowPlayingContextProvider component, including children React nodes.
+ */
 interface NowPlayingContextInterface {
   children: React.ReactNode;
 }
 
 const NowPlayingContext = React.createContext({} as NowPlayingContext);
 
+/**
+ * Provides a React context for managing audio playback within the app.
+ * This component sets up the audio player and source elements, and provides play, stop, and resume functions.
+ */
 const NowPlayingContextProvider = ({
   children,
 }: NowPlayingContextInterface) => {
@@ -99,6 +133,10 @@ const NowPlayingContextProvider = ({
   );
 };
 
+/**
+ * Custom hook to access the NowPlaying context.
+ * @returns The NowPlayingContext with audio playback control functions.
+ */
 function useNowPlaying() {
   return React.useContext(NowPlayingContext);
 }