@siberiacancode/reactuse 0.2.22 → 0.2.23

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/types/hooks/index.d.ts

@@ -5,6 +5,7 @@ export * from './useBattery/useBattery';
 export * from './useBluetooth/useBluetooth';
 export * from './useBoolean/useBoolean';
 export * from './useBreakpoints/useBreakpoints';
+export * from './useBroadcastChannel/useBroadcastChannel';
 export * from './useBrowserLanguage/useBrowserLanguage';
 export * from './useClickOutside/useClickOutside';
 export * from './useClipboard/useClipboard';

package/dist/types/hooks/useBroadcastChannel/useBroadcastChannel.d.ts

@@ -0,0 +1,32 @@
+/** The use broadcast channel return type */
+export interface UseBroadcastChannelReturn<Data = unknown> {
+    /** The underlying BroadcastChannel instance if supported, undefined otherwise */
+    channel?: BroadcastChannel;
+    /** Whether the channel has been closed */
+    closed: boolean;
+    /** The most recently received data from other contexts */
+    data?: Data;
+    /** Error object if any error occurred during channel operations */
+    error?: Event;
+    /** Whether the BroadcastChannel API is supported in the current environment */
+    supported: boolean;
+    /** Function to close the channel and clean up resources */
+    close: () => void;
+    /** Function to send data to other contexts through the channel */
+    post: (data: Data) => void;
+}
+/**
+ * @name useBroadcastChannel
+ * @description Hook that provides cross-tab/window communication
+ * @category Browser
+ *
+ * @browserapi BroadcastChannel https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel
+ *
+ * @param {string} name The name of the channel
+ * @param {Function} callback A callback function that will be called when a message is received
+ * @returns {UseBroadcastChannelReturn} An object containing the channel state and controls
+ *
+ * @example
+ * const { supported, data, post, error } = useBroadcastChannel('channel');
+ */
+export declare const useBroadcastChannel: <Data = unknown>(name: string, callback?: (data: Data) => void) => UseBroadcastChannelReturn<Data>;

package/dist/types/hooks/useTime/useTime.d.ts

@@ -1,14 +1,22 @@
 export interface UseTimeReturn {
+    /** The current day of the month (1-31) */
     day: number;
+    /** The current hour in 24-hour format (0-23) */
     hours: number;
+    /** The current hour in 12-hour format with meridiem type (AM/PM) */
     meridiemHours: {
         value: number;
         type: string;
     };
+    /** The current minute (0-59) */
     minutes: number;
+    /** The current month (1-12) */
     month: number;
+    /** The current second (0-59) */
     seconds: number;
+    /** The current Unix timestamp in milliseconds */
     timestamp: number;
+    /** The current year */
     year: number;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.2.22",
+  "version": "0.2.23",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",