Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

BaseQueryNarrowing.md

72 lines1.9 KB

1---
2id: BaseQueryNarrowing
3title: BaseQueryNarrowing
4---
5​
6# Interface: BaseQueryNarrowing\<TData, TError\>
7​
8## Type Parameters
9​
10β€’ **TData** = `unknown`
11​
12β€’ **TError** = `DefaultError`
13​
14## Properties
15​
16### isError()
17​
18```ts
19isError: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>;
20```
21​
22#### Parameters
23​
24β€’ **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
25​
26#### Returns
27​
28`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"error", TData, TError>>`
29​
30#### Defined in
31​
32[types.ts:75](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L75)
33​
34---
35​
36### isPending()
37​
38```ts
39isPending: (this) => this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>;
40```
41​
42#### Parameters
43​
44β€’ **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
45​
46#### Returns
47​
48`this is CreateBaseQueryResult<TData, TError, CreateStatusBasedQueryResult<"pending", TData, TError>>`
49​
50#### Defined in
51​
52[types.ts:82](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L82)
53​
54---
55​
56### isSuccess()
57​
58```ts
59isSuccess: (this) => this is CreateBaseQueryResult<TData, TError, QueryObserverSuccessResult<TData, TError>>;
60```
61​
62#### Parameters
63​
64β€’ **this**: [`CreateBaseQueryResult`](CreateBaseQueryResult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\>
65​
66#### Returns
67​
68`this is CreateBaseQueryResult<TData, TError, QueryObserverSuccessResult<TData, TError>>`
69​
70#### Defined in
71​
72[types.ts:68](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L68)