Skip to content

Commit fd618b5

Browse files
docs: regenerate API documentation
1 parent be656be commit fd618b5

143 files changed

Lines changed: 2289 additions & 307 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/@tanstack/namespaces/IR/classes/Aggregate.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Aggregate
55

66
# Class: Aggregate\<T\>
77

8-
Defined in: [packages/db/src/query/ir.ts:129](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L129)
8+
Defined in: [packages/db/src/query/ir.ts:162](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L162)
99

1010
## Extends
1111

@@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:129](https://github.com/TanStack/db/blo
2525
new Aggregate<T>(name, args): Aggregate<T>;
2626
```
2727

28-
Defined in: [packages/db/src/query/ir.ts:131](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L131)
28+
Defined in: [packages/db/src/query/ir.ts:164](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L164)
2929

3030
#### Parameters
3131

@@ -55,7 +55,7 @@ BaseExpression<T>.constructor
5555
readonly __returnType: T;
5656
```
5757

58-
Defined in: [packages/db/src/query/ir.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L73)
58+
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
5959

6060
**`Internal`**
6161

@@ -75,7 +75,7 @@ BaseExpression.__returnType
7575
args: BasicExpression<any>[];
7676
```
7777

78-
Defined in: [packages/db/src/query/ir.ts:133](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L133)
78+
Defined in: [packages/db/src/query/ir.ts:166](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L166)
7979

8080
***
8181

@@ -85,7 +85,7 @@ Defined in: [packages/db/src/query/ir.ts:133](https://github.com/TanStack/db/blo
8585
name: string;
8686
```
8787

88-
Defined in: [packages/db/src/query/ir.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L132)
88+
Defined in: [packages/db/src/query/ir.ts:165](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L165)
8989

9090
***
9191

@@ -95,7 +95,7 @@ Defined in: [packages/db/src/query/ir.ts:132](https://github.com/TanStack/db/blo
9595
type: "agg";
9696
```
9797

98-
Defined in: [packages/db/src/query/ir.ts:130](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L130)
98+
Defined in: [packages/db/src/query/ir.ts:163](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L163)
9999

100100
#### Overrides
101101

docs/reference/@tanstack/namespaces/IR/classes/CollectionRef.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: CollectionRef
55

66
# Class: CollectionRef
77

8-
Defined in: [packages/db/src/query/ir.ts:76](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L76)
8+
Defined in: [packages/db/src/query/ir.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L81)
99

1010
## Extends
1111

@@ -19,7 +19,7 @@ Defined in: [packages/db/src/query/ir.ts:76](https://github.com/TanStack/db/blob
1919
new CollectionRef(collection, alias): CollectionRef;
2020
```
2121

22-
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
22+
Defined in: [packages/db/src/query/ir.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L83)
2323

2424
#### Parameters
2525

@@ -49,7 +49,7 @@ BaseExpression.constructor
4949
readonly __returnType: any;
5050
```
5151

52-
Defined in: [packages/db/src/query/ir.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L73)
52+
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
5353

5454
**`Internal`**
5555

@@ -69,7 +69,7 @@ BaseExpression.__returnType
6969
alias: string;
7070
```
7171

72-
Defined in: [packages/db/src/query/ir.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L80)
72+
Defined in: [packages/db/src/query/ir.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L85)
7373

7474
***
7575

@@ -79,7 +79,7 @@ Defined in: [packages/db/src/query/ir.ts:80](https://github.com/TanStack/db/blob
7979
collection: CollectionImpl;
8080
```
8181

82-
Defined in: [packages/db/src/query/ir.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L79)
82+
Defined in: [packages/db/src/query/ir.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L84)
8383

8484
***
8585

@@ -89,7 +89,7 @@ Defined in: [packages/db/src/query/ir.ts:79](https://github.com/TanStack/db/blob
8989
type: "collectionRef";
9090
```
9191

92-
Defined in: [packages/db/src/query/ir.ts:77](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L77)
92+
Defined in: [packages/db/src/query/ir.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L82)
9393

9494
#### Overrides
9595

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
id: ConditionalSelect
3+
title: ConditionalSelect
4+
---
5+
6+
# Class: ConditionalSelect
7+
8+
Defined in: [packages/db/src/query/ir.ts:200](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L200)
9+
10+
## Extends
11+
12+
- `BaseExpression`
13+
14+
## Constructors
15+
16+
### Constructor
17+
18+
```ts
19+
new ConditionalSelect(branches, defaultValue?): ConditionalSelect;
20+
```
21+
22+
Defined in: [packages/db/src/query/ir.ts:202](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L202)
23+
24+
#### Parameters
25+
26+
##### branches
27+
28+
[`ConditionalSelectBranch`](../type-aliases/ConditionalSelectBranch.md)[]
29+
30+
##### defaultValue?
31+
32+
[`SelectValueExpression`](../type-aliases/SelectValueExpression.md)
33+
34+
#### Returns
35+
36+
`ConditionalSelect`
37+
38+
#### Overrides
39+
40+
```ts
41+
BaseExpression.constructor
42+
```
43+
44+
## Properties
45+
46+
### \_\_returnType
47+
48+
```ts
49+
readonly __returnType: any;
50+
```
51+
52+
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
53+
54+
**`Internal`**
55+
56+
- Type brand for TypeScript inference
57+
58+
#### Inherited from
59+
60+
```ts
61+
BaseExpression.__returnType
62+
```
63+
64+
***
65+
66+
### branches
67+
68+
```ts
69+
branches: ConditionalSelectBranch[];
70+
```
71+
72+
Defined in: [packages/db/src/query/ir.ts:203](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L203)
73+
74+
***
75+
76+
### defaultValue?
77+
78+
```ts
79+
optional defaultValue: SelectValueExpression;
80+
```
81+
82+
Defined in: [packages/db/src/query/ir.ts:204](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L204)
83+
84+
***
85+
86+
### type
87+
88+
```ts
89+
type: "conditionalSelect";
90+
```
91+
92+
Defined in: [packages/db/src/query/ir.ts:201](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L201)
93+
94+
#### Overrides
95+
96+
```ts
97+
BaseExpression.type
98+
```

docs/reference/@tanstack/namespaces/IR/classes/Func.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Func
55

66
# Class: Func\<T\>
77

8-
Defined in: [packages/db/src/query/ir.ts:114](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L114)
8+
Defined in: [packages/db/src/query/ir.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L147)
99

1010
## Extends
1111

@@ -25,7 +25,7 @@ Defined in: [packages/db/src/query/ir.ts:114](https://github.com/TanStack/db/blo
2525
new Func<T>(name, args): Func<T>;
2626
```
2727

28-
Defined in: [packages/db/src/query/ir.ts:116](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L116)
28+
Defined in: [packages/db/src/query/ir.ts:149](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L149)
2929

3030
#### Parameters
3131

@@ -55,7 +55,7 @@ BaseExpression<T>.constructor
5555
readonly __returnType: T;
5656
```
5757

58-
Defined in: [packages/db/src/query/ir.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L73)
58+
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
5959

6060
**`Internal`**
6161

@@ -75,7 +75,7 @@ BaseExpression.__returnType
7575
args: BasicExpression<any>[];
7676
```
7777

78-
Defined in: [packages/db/src/query/ir.ts:118](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L118)
78+
Defined in: [packages/db/src/query/ir.ts:151](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L151)
7979

8080
***
8181

@@ -85,7 +85,7 @@ Defined in: [packages/db/src/query/ir.ts:118](https://github.com/TanStack/db/blo
8585
name: string;
8686
```
8787

88-
Defined in: [packages/db/src/query/ir.ts:117](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L117)
88+
Defined in: [packages/db/src/query/ir.ts:150](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L150)
8989

9090
***
9191

@@ -95,7 +95,7 @@ Defined in: [packages/db/src/query/ir.ts:117](https://github.com/TanStack/db/blo
9595
type: "func";
9696
```
9797

98-
Defined in: [packages/db/src/query/ir.ts:115](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L115)
98+
Defined in: [packages/db/src/query/ir.ts:148](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L148)
9999

100100
#### Overrides
101101

docs/reference/@tanstack/namespaces/IR/classes/IncludesSubquery.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: IncludesSubquery
55

66
# Class: IncludesSubquery
77

8-
Defined in: [packages/db/src/query/ir.ts:139](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L139)
8+
Defined in: [packages/db/src/query/ir.ts:172](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L172)
99

1010
## Extends
1111

@@ -27,7 +27,7 @@ new IncludesSubquery(
2727
scalarField?): IncludesSubquery;
2828
```
2929
30-
Defined in: [packages/db/src/query/ir.ts:141](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L141)
30+
Defined in: [packages/db/src/query/ir.ts:174](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L174)
3131
3232
#### Parameters
3333
@@ -81,7 +81,7 @@ BaseExpression.constructor
8181
readonly __returnType: any;
8282
```
8383
84-
Defined in: [packages/db/src/query/ir.ts:73](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L73)
84+
Defined in: [packages/db/src/query/ir.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L78)
8585
8686
**`Internal`**
8787
@@ -101,7 +101,7 @@ BaseExpression.__returnType
101101
childCorrelationField: PropRef;
102102
```
103103
104-
Defined in: [packages/db/src/query/ir.ts:144](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L144)
104+
Defined in: [packages/db/src/query/ir.ts:177](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L177)
105105
106106
***
107107
@@ -111,7 +111,7 @@ Defined in: [packages/db/src/query/ir.ts:144](https://github.com/TanStack/db/blo
111111
correlationField: PropRef;
112112
```
113113
114-
Defined in: [packages/db/src/query/ir.ts:143](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L143)
114+
Defined in: [packages/db/src/query/ir.ts:176](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L176)
115115
116116
***
117117
@@ -121,7 +121,7 @@ Defined in: [packages/db/src/query/ir.ts:143](https://github.com/TanStack/db/blo
121121
fieldName: string;
122122
```
123123
124-
Defined in: [packages/db/src/query/ir.ts:145](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L145)
124+
Defined in: [packages/db/src/query/ir.ts:178](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L178)
125125
126126
***
127127
@@ -131,7 +131,7 @@ Defined in: [packages/db/src/query/ir.ts:145](https://github.com/TanStack/db/blo
131131
materialization: IncludesMaterialization;
132132
```
133133
134-
Defined in: [packages/db/src/query/ir.ts:148](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L148)
134+
Defined in: [packages/db/src/query/ir.ts:181](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L181)
135135
136136
***
137137
@@ -141,7 +141,7 @@ Defined in: [packages/db/src/query/ir.ts:148](https://github.com/TanStack/db/blo
141141
optional parentFilters: Where[];
142142
```
143143
144-
Defined in: [packages/db/src/query/ir.ts:146](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L146)
144+
Defined in: [packages/db/src/query/ir.ts:179](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L179)
145145
146146
***
147147
@@ -151,7 +151,7 @@ Defined in: [packages/db/src/query/ir.ts:146](https://github.com/TanStack/db/blo
151151
optional parentProjection: PropRef<any>[];
152152
```
153153
154-
Defined in: [packages/db/src/query/ir.ts:147](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L147)
154+
Defined in: [packages/db/src/query/ir.ts:180](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L180)
155155
156156
***
157157
@@ -161,7 +161,7 @@ Defined in: [packages/db/src/query/ir.ts:147](https://github.com/TanStack/db/blo
161161
query: QueryIR;
162162
```
163163
164-
Defined in: [packages/db/src/query/ir.ts:142](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L142)
164+
Defined in: [packages/db/src/query/ir.ts:175](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L175)
165165
166166
***
167167
@@ -171,7 +171,7 @@ Defined in: [packages/db/src/query/ir.ts:142](https://github.com/TanStack/db/blo
171171
optional scalarField: string;
172172
```
173173
174-
Defined in: [packages/db/src/query/ir.ts:149](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L149)
174+
Defined in: [packages/db/src/query/ir.ts:182](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L182)
175175
176176
***
177177
@@ -181,7 +181,7 @@ Defined in: [packages/db/src/query/ir.ts:149](https://github.com/TanStack/db/blo
181181
type: "includesSubquery";
182182
```
183183
184-
Defined in: [packages/db/src/query/ir.ts:140](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L140)
184+
Defined in: [packages/db/src/query/ir.ts:173](https://github.com/TanStack/db/blob/main/packages/db/src/query/ir.ts#L173)
185185
186186
#### Overrides
187187

0 commit comments

Comments
 (0)