본문으로 건너뛰기

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

매개변수​

queryFn의 타입으로 태그할 쿼리 옵션입니다.

호출 시그니처​

function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;

정의 위치: query-options.ts:76

쿼리 옵션을 타입 안전한 방식으로 공유하고 재사용할 수 있습니다.

queryKey에는 queryFn의 타입이 지정됩니다.

예시

 const { queryKey } = queryOptions({
    queryKey: ['key'],
    queryFn: () => Promise.resolve(5),
    //  ^?  Promise<number>
  })

  const queryClient = new QueryClient()
  const data = queryClient.getQueryData(queryKey)
  //    ^?  number | undefined

타입 매개변수​

TQueryFnData​

TQueryFnData = unknown

TError​

TError = Error

TData​

TData = TQueryFnData

TQueryKey​

TQueryKey extends readonly unknown[] = readonly unknown[]

매개변수​

옵션​

DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>

queryFn의 타입으로 태그할 쿼리 옵션입니다.

반환값​

Omit<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>

태그가 지정된 쿼리 옵션입니다.

호출 시그니처​

function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): OmitKeyof<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;

정의 위치: query-options.ts:107

쿼리 옵션을 타입 안전한 방식으로 공유하고 재사용할 수 있습니다.

queryKey에는 queryFn의 타입이 지정됩니다.

예시

 const { queryKey } = queryOptions({
    queryKey: ['key'],
    queryFn: () => Promise.resolve(5),
    //  ^?  Promise<number>
  })

  const queryClient = new QueryClient()
  const data = queryClient.getQueryData(queryKey)
  //    ^?  number | undefined

타입 매개변수​

TQueryFnData​

TQueryFnData = unknown

TError​

TError = Error

TData​

TData = TQueryFnData

TQueryKey​

TQueryKey extends readonly unknown[] = readonly unknown[]

매개변수​

옵션​

UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>

queryFn의 타입으로 태그할 쿼리 옵션입니다.

반환값​

OmitKeyof<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>

태그가 지정된 쿼리 옵션입니다.

호출 시그니처​

function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options): CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;

정의 위치: query-options.ts:138

쿼리 옵션을 타입 안전한 방식으로 공유하고 재사용할 수 있습니다.

queryKey에는 queryFn의 타입이 지정됩니다.

예시

 const { queryKey } = queryOptions({
    queryKey: ['key'],
    queryFn: () => Promise.resolve(5),
    //  ^?  Promise<number>
  })

  const queryClient = new QueryClient()
  const data = queryClient.getQueryData(queryKey)
  //    ^?  number | undefined

타입 매개변수​

TQueryFnData​

TQueryFnData = unknown

TError​

TError = Error

TData​

TData = TQueryFnData

TQueryKey​

TQueryKey extends readonly unknown[] = readonly unknown[]

매개변수​

옵션​

UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>

queryFn의 타입으로 태그할 쿼리 옵션입니다.

반환값​

CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>

태그가 지정된 쿼리 옵션입니다.