fix(query-broadcast-client): allow passing all broadcast-channel options (#5925)

* fix(query-broadcast-client): allow passing in type for the channel

allowed values are: 'native', 'idb', 'localstorage', 'node'

* fix(query-broadcast-client): allow passing all broadcast-channel options

* docs: options

Author: TkDodo

docs/react/plugins/broadcastQueryClient.md

@@ -47,6 +47,8 @@ interface broadcastQueryClient {
   /** This is the unique channel name that will be used
    * to communicate between tabs and windows */
   broadcastChannel?: string
+  /** Options for the BroadcastChannel API */
+  options?: BroadcastChannelOptions
 }
 ```
 

packages/query-broadcast-client-experimental/src/index.ts

@@ -1,14 +1,17 @@
 import { BroadcastChannel } from 'broadcast-channel'
+import type { BroadcastChannelOptions } from 'broadcast-channel'
 import type { QueryClient } from '@tanstack/query-core'
 
 interface BroadcastQueryClientOptions {
   queryClient: QueryClient
   broadcastChannel?: string
+  options?: BroadcastChannelOptions
 }
 
 export function broadcastQueryClient({
   queryClient,
   broadcastChannel = 'tanstack-query',
+  options,
 }: BroadcastQueryClientOptions) {
   let transaction = false
   const tx = (cb: () => void) => {
@@ -19,6 +22,7 @@ export function broadcastQueryClient({
 
   const channel = new BroadcastChannel(broadcastChannel, {
     webWorkerSupport: false,
+    ...options,
   })
 
   const queryCache = queryClient.getQueryCache()