react-broadcast-sync 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +26 -0
- package/dist/hooks/useBroadcastChannel.d.ts +10 -0
- package/dist/index.cjs.js +1 -1
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/types/types.d.ts +9 -0
- package/dist/utils/debug.d.ts +3 -0
- package/dist/utils/messageUtils.d.ts +2 -2
- package/package.json +1 -1
- package/src/hooks/useBroadcastChannel.ts +165 -18
- package/src/tests/BroadcastProvider.test.tsx +1 -1
- package/src/tests/useBroadcastChannel.same-tab.test.tsx +15 -4
- package/src/tests/useBroadcastChannel.test.tsx +1024 -691
- package/src/types/types.ts +14 -0
- package/src/utils/debug.ts +3 -0
- package/src/utils/messageUtils.ts +2 -2
package/src/types/types.ts
CHANGED
|
@@ -22,6 +22,12 @@ export interface BroadcastOptions {
|
|
|
22
22
|
|
|
23
23
|
/** Debounce time for messages cleanup in milliseconds (default: 1000) */
|
|
24
24
|
cleanupDebounceMs?: number;
|
|
25
|
+
|
|
26
|
+
/** Delay in milliseconds for batching messages (default: 20) */
|
|
27
|
+
batchingDelayMs?: number;
|
|
28
|
+
|
|
29
|
+
/** Array of message types that should not be batched and sent immediately (default: []) */
|
|
30
|
+
excludedBatchMessageTypes?: string[];
|
|
25
31
|
}
|
|
26
32
|
|
|
27
33
|
/**
|
|
@@ -88,6 +94,12 @@ export interface BroadcastActions {
|
|
|
88
94
|
/** Array of sent messages */
|
|
89
95
|
sentMessages: BroadcastMessage[];
|
|
90
96
|
|
|
97
|
+
/** Whether a ping operation is currently in progress */
|
|
98
|
+
isPingInProgress: boolean;
|
|
99
|
+
|
|
100
|
+
/** Function to ping the channel and get active sources */
|
|
101
|
+
ping: (timeoutMs?: number) => Promise<string[]>;
|
|
102
|
+
|
|
91
103
|
/** Function to send a message */
|
|
92
104
|
postMessage: (messageType: string, messageContent: any, options?: SendMessageOptions) => void;
|
|
93
105
|
|
|
@@ -108,3 +120,5 @@ export interface BroadcastActions {
|
|
|
108
120
|
}
|
|
109
121
|
|
|
110
122
|
export type ClearMessage = 'CLEAR_SENT_MESSAGES';
|
|
123
|
+
|
|
124
|
+
export type InternalMessage = ClearMessage | 'PING' | 'PONG';
|
package/src/utils/debug.ts
CHANGED
|
@@ -43,6 +43,9 @@ export const debug = {
|
|
|
43
43
|
ignored: (messageType: string) =>
|
|
44
44
|
log('info', 'Message ignored due to type filter:', messageType),
|
|
45
45
|
},
|
|
46
|
+
ping: {
|
|
47
|
+
inProgress: () => log('warn', 'Ping already in progress. Skipping call.'),
|
|
48
|
+
},
|
|
46
49
|
cleanup: {
|
|
47
50
|
started: () => log('info', 'Cleanup started'),
|
|
48
51
|
completed: (removedCount: number) => log('info', 'Cleanup completed:', { removedCount }),
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { InternalMessage } from '../types/types';
|
|
2
2
|
|
|
3
3
|
const INTERNAL_PREFIX = '__INTERNAL__';
|
|
4
4
|
const SECRET = 'react-broadcast-sync';
|
|
@@ -46,7 +46,7 @@ export const createMessage = (
|
|
|
46
46
|
};
|
|
47
47
|
|
|
48
48
|
export const getInternalMessageType = (
|
|
49
|
-
baseType:
|
|
49
|
+
baseType: InternalMessage,
|
|
50
50
|
channelName: string,
|
|
51
51
|
namespace = ''
|
|
52
52
|
): string => {
|