函数: queryOptions()

允许以类型安全的方式共享和重用查询选项。

queryKey 将会被 queryFn 的类型进行标记。

示例

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

将被 queryFn 的类型进行标记的查询选项。

调用签名

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

允许以类型安全的方式共享和重用查询选项。

queryKey 将会被 queryFn 的类型进行标记。

示例

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

类型参数

• TQueryFnData = unknown

• TError = Error

• TData = TQueryFnData

• TQueryKey extends readonly unknown[] = readonly unknown[]

参数

options

DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>

将被 queryFn 的类型进行标记的查询选项。

Returns (返回)

DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> & object

标记后的查询选项。

Param

将被 queryFn 的类型进行标记的查询选项。

定义于

query-options.ts:78

调用签名

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

允许以类型安全的方式共享和重用查询选项。

queryKey 将会被 queryFn 的类型进行标记。

示例

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

类型参数

• TQueryFnData = unknown

• TError = Error

• TData = TQueryFnData

• TQueryKey extends readonly unknown[] = readonly unknown[]

参数

options

UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>

将被 queryFn 的类型进行标记的查询选项。

Returns (返回)

UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey> & object

标记后的查询选项。

Param

将被 queryFn 的类型进行标记的查询选项。

定义于

query-options.ts:111

调用签名

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

允许以类型安全的方式共享和重用查询选项。

queryKey 将会被 queryFn 的类型进行标记。

示例

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