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

BaseQueryNarrowing.md

78 lines1.8 KB

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