queryOptions
Funktion: queryOptions()
Ermöglicht das Teilen und Wiederverwenden von Query-Optionen auf typsichere Weise.
Der queryKey wird mit dem Typ von queryFn getaggt.
Beispiel
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
Param
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Aufruf-Signatur
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
Ermöglicht das Teilen und Wiederverwenden von Query-Optionen auf typsichere Weise.
Der queryKey wird mit dem Typ von queryFn getaggt.
Beispiel
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
Typparameter
• TQueryFnData = unbekannt
• TError = Error
• TData = TQueryFnData
• TQueryKey extends readonly unknown[] = readonly unknown[]
Parameter
options
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Gibt zurück
DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
Die getaggten Query-Optionen.
Die getaggten Query-Optionen.
Param
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Definiert in
Aufruf-Signatur
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object
Ermöglicht das Teilen und Wiederverwenden von Query-Optionen auf typsichere Weise.
Der queryKey wird mit dem Typ von queryFn getaggt.
Beispiel
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
Typparameter
• TQueryFnData = unbekannt
• TError = Error
• TData = TQueryFnData
• TQueryKey extends readonly unknown[] = readonly unknown[]
Parameter
options
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Gibt zurück
UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object
Die getaggten Query-Optionen.
Die getaggten Query-Optionen.
Param
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Definiert in
Aufruf-Signatur
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(
options,
): UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
Ermöglicht das Teilen und Wiederverwenden von Query-Optionen auf typsichere Weise.
Der queryKey wird mit dem Typ von queryFn getaggt.
Beispiel
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
const { queryKey } = queryOptions({
queryKey: ['key'],
queryFn: () => Promise.resolve(5),
// ^? Promise<number>
})
const queryClient = new QueryClient()
const data = queryClient.getQueryData(queryKey)
// ^? number | undefined
Typparameter
• TQueryFnData = unbekannt
• TError = Error
• TData = TQueryFnData
• TQueryKey extends readonly unknown[] = readonly unknown[]
Parameter
options
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
Gibt zurück
UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object
Die getaggten Query-Optionen.
Die getaggten Query-Optionen.
Param
Die Query-Optionen, die mit dem Typ von queryFn getaggt werden.
