0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/interfaces/CreateBaseQueryOptions.md
Wonsuk Choi 9810709718
docs(angular-query-experimental): add JSDoc across the package (#11406)
* docs(angular-query-experimental): add JSDoc across the package and generate reference docs with TypeDoc

* docs(angular-query-experimental): address CodeRabbit review comments on JSDoc accuracy

* docs(angular-query-experimental): use 'changes' instead of 'narrows' for select's effect on TData
2026-09-06 12:12:24 +09:00

1.1 KiB

id title
CreateBaseQueryOptions CreateBaseQueryOptions

Defined in: types.ts:34

The options shared across angular-query-experimental's query functions. Extends QueryObserverOptions from @tanstack/query-core as-is — unlike react-query, angular-query-experimental has no extra framework-specific option here.

Extends

  • QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

Type Parameters

TQueryFnData

TQueryFnData = unknown

The type your queryFn resolves to.

TError

TError = DefaultError

The type of errors your queryFn may throw.

TData

TData = TQueryFnData

The type data ends up as after select runs. Defaults to TQueryFnData when no select is used.

TQueryData

TQueryData = TQueryFnData

The type of the data actually held in the query cache — the input to select and placeholderData. Defaults to, and is usually the same as, TQueryFnData.

TQueryKey

TQueryKey extends QueryKey = QueryKey

The type of your queryKey.