Skip to content

Commit 464c74c

Browse files
kevin-dpkevin-dp
committed
Docs update
1 parent fe1623a commit 464c74c

File tree

11 files changed

+46
-33
lines changed

11 files changed

+46
-33
lines changed

‎docs/reference/classes/CollectionImpl.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,14 @@ Defined in: [packages/db/src/collection/index.ts:215](https://github.com/TanStac
129129
#### Get Signature
130130

131131
```ts
132-
get compareOptions(): StringSortOpts;
132+
get compareOptions(): StringCollationConfig;
133133
```
134134

135135
Defined in: [packages/db/src/collection/index.ts:516](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L516)
136136

137137
##### Returns
138138

139-
[`StringSortOpts`](../../type-aliases/StringSortOpts.md)
139+
[`StringCollationConfig`](../../type-aliases/StringCollationConfig.md)
140140

141141
***
142142

‎docs/reference/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ title: "@tanstack/db"
194194
- [StorageEventApi](../type-aliases/StorageEventApi.md)
195195
- [Strategy](../type-aliases/Strategy.md)
196196
- [StrategyOptions](../type-aliases/StrategyOptions.md)
197-
- [StringSortOpts](../type-aliases/StringSortOpts.md)
197+
- [StringCollationConfig](../type-aliases/StringCollationConfig.md)
198198
- [SubscriptionEvents](../type-aliases/SubscriptionEvents.md)
199199
- [SubscriptionStatus](../type-aliases/SubscriptionStatus.md)
200200
- [SyncConfigRes](../type-aliases/SyncConfigRes.md)

‎docs/reference/interfaces/BaseCollectionConfig.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime()
100100

101101
***
102102

103-
### compareOptions?
103+
### defaultStringCollation?
104104

105105
```ts
106-
optional compareOptions: StringSortOpts;
106+
optional defaultStringCollation: StringCollationConfig;
107107
```
108108

109109
Defined in: [packages/db/src/types.ts:622](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L622)

‎docs/reference/interfaces/Collection.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,14 @@ Defined in: [packages/db/src/collection/index.ts:55](https://github.com/TanStack
144144
#### Get Signature
145145

146146
```ts
147-
get compareOptions(): StringSortOpts;
147+
get compareOptions(): StringCollationConfig;
148148
```
149149

150150
Defined in: [packages/db/src/collection/index.ts:516](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L516)
151151

152152
##### Returns
153153

154-
[`StringSortOpts`](../../type-aliases/StringSortOpts.md)
154+
[`StringCollationConfig`](../../type-aliases/StringCollationConfig.md)
155155

156156
#### Inherited from
157157

‎docs/reference/interfaces/CollectionConfig.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime()
103103

104104
***
105105

106-
### compareOptions?
106+
### defaultStringCollation?
107107

108108
```ts
109-
optional compareOptions: StringSortOpts;
109+
optional defaultStringCollation: StringCollationConfig;
110110
```
111111

112112
Defined in: [packages/db/src/types.ts:622](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L622)
@@ -118,7 +118,7 @@ E.g., when using the Electric DB collection these options
118118

119119
#### Inherited from
120120

121-
[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`compareOptions`](../BaseCollectionConfig.md#compareoptions)
121+
[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`defaultStringCollation`](../BaseCollectionConfig.md#defaultstringcollation)
122122

123123
***
124124

‎docs/reference/interfaces/CollectionLike.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ for the change events system to work
2929
### compareOptions
3030

3131
```ts
32-
compareOptions: StringSortOpts;
32+
compareOptions: StringCollationConfig;
3333
```
3434

3535
Defined in: [packages/db/src/collection/index.ts:516](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L516)

‎docs/reference/interfaces/LiveQueryCollectionConfig.md‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: LiveQueryCollectionConfig
55

66
# Interface: LiveQueryCollectionConfig\<TContext, TResult\>
77

8-
Defined in: [packages/db/src/query/live/types.ts:49](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L49)
8+
Defined in: [packages/db/src/query/live/types.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L53)
99

1010
Configuration interface for live query collection options
1111

@@ -43,13 +43,26 @@ const config: LiveQueryCollectionConfig<any, any> = {
4343

4444
## Properties
4545

46+
### defaultStringCollation?
47+
48+
```ts
49+
optional defaultStringCollation: StringCollationConfig;
50+
```
51+
52+
Defined in: [packages/db/src/query/live/types.ts:107](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L107)
53+
54+
Optional compare options for string sorting.
55+
If provided, these will be used instead of inheriting from the FROM collection.
56+
57+
***
58+
4659
### gcTime?
4760

4861
```ts
4962
optional gcTime: number;
5063
```
5164

52-
Defined in: [packages/db/src/query/live/types.ts:92](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L92)
65+
Defined in: [packages/db/src/query/live/types.ts:96](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L96)
5366

5467
GC time for the collection
5568

@@ -61,7 +74,7 @@ GC time for the collection
6174
optional getKey: (item) => string | number;
6275
```
6376

64-
Defined in: [packages/db/src/query/live/types.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L70)
77+
Defined in: [packages/db/src/query/live/types.ts:74](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L74)
6578

6679
Function to extract the key from result items
6780
If not provided, defaults to using the key from the D2 stream
@@ -84,7 +97,7 @@ If not provided, defaults to using the key from the D2 stream
8497
optional id: string;
8598
```
8699

87-
Defined in: [packages/db/src/query/live/types.ts:57](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L57)
100+
Defined in: [packages/db/src/query/live/types.ts:61](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L61)
88101

89102
Unique identifier for the collection
90103
If not provided, defaults to `live-query-${number}` with auto-incrementing number
@@ -97,7 +110,7 @@ If not provided, defaults to `live-query-${number}` with auto-incrementing numbe
97110
optional onDelete: DeleteMutationFn<TResult, string | number, UtilsRecord, any>;
98111
```
99112

100-
Defined in: [packages/db/src/query/live/types.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L82)
113+
Defined in: [packages/db/src/query/live/types.ts:86](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L86)
101114

102115
***
103116

@@ -107,7 +120,7 @@ Defined in: [packages/db/src/query/live/types.ts:82](https://github.com/TanStack
107120
optional onInsert: InsertMutationFn<TResult, string | number, UtilsRecord, any>;
108121
```
109122

110-
Defined in: [packages/db/src/query/live/types.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L80)
123+
Defined in: [packages/db/src/query/live/types.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L84)
111124

112125
Optional mutation handlers
113126

@@ -119,7 +132,7 @@ Optional mutation handlers
119132
optional onUpdate: UpdateMutationFn<TResult, string | number, UtilsRecord, any>;
120133
```
121134

122-
Defined in: [packages/db/src/query/live/types.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L81)
135+
Defined in: [packages/db/src/query/live/types.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L85)
123136

124137
***
125138

@@ -131,7 +144,7 @@ query:
131144
| (q) => QueryBuilder<TContext>;
132145
```
133146

134-
Defined in: [packages/db/src/query/live/types.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L62)
147+
Defined in: [packages/db/src/query/live/types.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L66)
135148

136149
Query builder function that defines the live query
137150

@@ -143,7 +156,7 @@ Query builder function that defines the live query
143156
optional schema: undefined;
144157
```
145158

146-
Defined in: [packages/db/src/query/live/types.ts:75](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L75)
159+
Defined in: [packages/db/src/query/live/types.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L79)
147160

148161
Optional schema for validation
149162

@@ -155,7 +168,7 @@ Optional schema for validation
155168
optional singleResult: true;
156169
```
157170

158-
Defined in: [packages/db/src/query/live/types.ts:97](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L97)
171+
Defined in: [packages/db/src/query/live/types.ts:101](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L101)
159172

160173
If enabled the collection will return a single object instead of an array
161174

@@ -167,6 +180,6 @@ If enabled the collection will return a single object instead of an array
167180
optional startSync: boolean;
168181
```
169182

170-
Defined in: [packages/db/src/query/live/types.ts:87](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L87)
183+
Defined in: [packages/db/src/query/live/types.ts:91](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/types.ts#L91)
171184

172185
Start sync / the query immediately

‎docs/reference/interfaces/LocalOnlyCollectionConfig.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,10 @@ Omit.compare
109109

110110
***
111111

112-
### compareOptions?
112+
### defaultStringCollation?
113113

114114
```ts
115-
optional compareOptions: StringSortOpts;
115+
optional defaultStringCollation: StringCollationConfig;
116116
```
117117

118118
Defined in: [packages/db/src/types.ts:622](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L622)
@@ -125,7 +125,7 @@ E.g., when using the Electric DB collection these options
125125
#### Inherited from
126126

127127
```ts
128-
Omit.compareOptions
128+
Omit.defaultStringCollation
129129
```
130130

131131
***

‎docs/reference/interfaces/LocalStorageCollectionConfig.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,10 @@ compare: (x, y) => x.createdAt.getTime() - y.createdAt.getTime()
107107

108108
***
109109

110-
### compareOptions?
110+
### defaultStringCollation?
111111

112112
```ts
113-
optional compareOptions: StringSortOpts;
113+
optional defaultStringCollation: StringCollationConfig;
114114
```
115115

116116
Defined in: [packages/db/src/types.ts:622](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L622)
@@ -122,7 +122,7 @@ E.g., when using the Electric DB collection these options
122122

123123
#### Inherited from
124124

125-
[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`compareOptions`](../BaseCollectionConfig.md#compareoptions)
125+
[`BaseCollectionConfig`](../BaseCollectionConfig.md).[`defaultStringCollation`](../BaseCollectionConfig.md#defaultstringcollation)
126126

127127
***
128128

‎docs/reference/type-aliases/LiveQueryCollectionUtils.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: LiveQueryCollectionUtils
99
type LiveQueryCollectionUtils = UtilsRecord & object;
1010
```
1111

12-
Defined in: [packages/db/src/query/live/collection-config-builder.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/collection-config-builder.ts#L36)
12+
Defined in: [packages/db/src/query/live/collection-config-builder.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/query/live/collection-config-builder.ts#L37)
1313

1414
## Type Declaration
1515

0 commit comments

Comments
 (0)