Auf dieser Seite
broadcastQueryClient (Experimentell)
SEHR WICHTIG: Dieses Dienstprogramm befindet sich derzeit in einer experimentellen Phase. Das bedeutet, dass es zu breaking changes in Minor- UND Patch-Releases kommen wird. Nutzen Sie es auf eigenes Risiko. Wenn Sie sich entscheiden, dies in einer experimentellen Phase in der Produktion zu verwenden, sperren Sie Ihre Version auf eine Patch-Level-Version, um unerwartete Fehler zu vermeiden.
broadcastQueryClient ist ein Dienstprogramm zum Übertragen und Synchronisieren des Zustands Ihres queryClient zwischen Browser-Tabs/Fenstern mit demselben Ursprung.
Installation
Dieses Dienstprogramm ist ein separates Paket und unter dem Import '@tanstack/query-broadcast-client-experimental' verfügbar.
Verwendung
Importieren Sie die Funktion broadcastQueryClient und übergeben Sie ihr Ihre QueryClient-Instanz und setzen Sie optional einen broadcastChannel.
import { broadcastQueryClient } from '@tanstack/query-broadcast-client-experimental'
const queryClient = new QueryClient()
broadcastQueryClient({
queryClient,
broadcastChannel: 'my-app',
})
import { broadcastQueryClient } from '@tanstack/query-broadcast-client-experimental'
const queryClient = new QueryClient()
broadcastQueryClient({
queryClient,
broadcastChannel: 'my-app',
})
API
broadcastQueryClient
Übergeben Sie dieser Funktion eine QueryClient-Instanz und optional einen broadcastChannel.
broadcastQueryClient({ queryClient, broadcastChannel })
broadcastQueryClient({ queryClient, broadcastChannel })
Optionen
Ein Objekt von Optionen
interface BroadcastQueryClientOptions {
/** The QueryClient to sync */
queryClient: QueryClient
/** 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
}
interface BroadcastQueryClientOptions {
/** The QueryClient to sync */
queryClient: QueryClient
/** 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
}
Die Standardoptionen sind
{
broadcastChannel = 'tanstack-query',
}
{
broadcastChannel = 'tanstack-query',
}
