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/BaseQueryNarrowing.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00

2.4 KiB

id title
BaseQueryNarrowing BaseQueryNarrowing

Defined in: packages/angular-query-experimental/src/types.ts:83

The isSuccess/isError/isPending methods on a query result. Unlike react-query's derived booleans, these are type-guard methods you call — if (query.isSuccess()) — so that query.data narrows away undefined inside the branch, the same way status narrowing works on the plain object react-query returns.

Type Parameters

TData

TData = unknown

The type data ends up as after select runs.

TError

TError = DefaultError

The type of errors your queryFn may throw.

Properties

isError()

isError: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>;

Defined in: packages/angular-query-experimental/src/types.ts:91

Parameters

this

CreateBaseQueryResult<TData, TError>

Returns

this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>


isPending()

isPending: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>;

Defined in: packages/angular-query-experimental/src/types.ts:98

Parameters

this

CreateBaseQueryResult<TData, TError>

Returns

this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>


isSuccess()

isSuccess: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"success", TData, TError>>;

Defined in: packages/angular-query-experimental/src/types.ts:84

Parameters

this

CreateBaseQueryResult<TData, TError>

Returns

this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"success", TData, TError>>