Merge pull request #51 from codeacme17/refactor

refactor(hook): add JS doc comment to `useOscilloscope` hook

Author: codeacme17

packages/hooks/useOscilloscope.ts

@@ -11,6 +11,27 @@ export interface UseOscilloscopeProps {
 
 const FFT_SIZE = 1024
 
+/**
+ * `useOscilloscope` is a custom React hook that integrates with Tone.js to create an oscilloscope.
+ * It is designed to capture and display real-time waveform data from an audio source.
+ *
+ * @param {UseOscilloscopeProps} props - The configuration properties for the oscilloscope.
+ * @param {number} [props.fftSize=1024] - The FFT size, must be a power of 2. Default is 1024.
+ * @param {Function} props.onReady - Callback executed when the oscilloscope is ready.
+ * @param {Function} props.onError - Callback executed in case of an error.
+ *
+ * @returns {object} An object containing various properties and methods for the oscilloscope:
+ * - init: Method to initialize the oscilloscope.
+ * - analyser: The Tone.Analyser instance used by the oscilloscope.
+ * - data: The current waveform data captured by the oscilloscope.
+ * - getData: Method to retrieve the current waveform data.
+ * - observe: Method to start the data observation.
+ * - cancelObserve: Method to stop the data observation.
+ * - error: Boolean indicating if an error has occurred.
+ * - errorMessage: The error message in case of an error.
+ *
+ * This hook can be useful in audio analysis applications, allowing for real-time visualization of waveform data.
+ */
 export const useOscilloscope = (props: UseOscilloscopeProps = {}) => {
   const { fftSize = FFT_SIZE, onReady, onError } = props