Skip to content

Commit 747c147

Browse files
docs: regenerate API documentation (#949)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 6ba4a9f commit 747c147

File tree

11 files changed

+563
-127
lines changed

11 files changed

+563
-127
lines changed

docs/reference/classes/CollectionImpl.md

Lines changed: 46 additions & 46 deletions
Large diffs are not rendered by default.

docs/reference/electric-db-collection/functions/electricCollectionOptions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ title: electricCollectionOptions
88
## Call Signature
99

1010
```ts
11-
function electricCollectionOptions<T>(config): CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord> & object;
11+
function electricCollectionOptions<T>(config): Omit<CollectionConfig<InferSchemaOutput<T>, string | number, T, UtilsRecord>, "utils"> & object;
1212
```
1313

14-
Defined in: [packages/electric-db-collection/src/electric.ts:403](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L403)
14+
Defined in: [packages/electric-db-collection/src/electric.ts:427](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L427)
1515

1616
Creates Electric collection options for use with a standard Collection
1717

@@ -33,17 +33,17 @@ Configuration options for the Electric collection
3333

3434
### Returns
3535

36-
`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `string` \| `number`, `T`, `UtilsRecord`\> & `object`
36+
`Omit`\<`CollectionConfig`\<`InferSchemaOutput`\<`T`\>, `string` \| `number`, `T`, `UtilsRecord`\>, `"utils"`\> & `object`
3737

3838
Collection options with utilities
3939

4040
## Call Signature
4141

4242
```ts
43-
function electricCollectionOptions<T>(config): CollectionConfig<T, string | number, never, UtilsRecord> & object;
43+
function electricCollectionOptions<T>(config): Omit<CollectionConfig<T, string | number, never, UtilsRecord>, "utils"> & object;
4444
```
4545

46-
Defined in: [packages/electric-db-collection/src/electric.ts:414](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L414)
46+
Defined in: [packages/electric-db-collection/src/electric.ts:438](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L438)
4747

4848
Creates Electric collection options for use with a standard Collection
4949

@@ -65,6 +65,6 @@ Configuration options for the Electric collection
6565

6666
### Returns
6767

68-
`CollectionConfig`\<`T`, `string` \| `number`, `never`, `UtilsRecord`\> & `object`
68+
`Omit`\<`CollectionConfig`\<`T`, `string` \| `number`, `never`, `UtilsRecord`\>, `"utils"`\> & `object`
6969

7070
Collection options with utilities

docs/reference/electric-db-collection/interfaces/ElectricCollectionConfig.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Configuration interface for Electric collection options
1111

1212
## Extends
1313

14-
- `Omit`\<`BaseCollectionConfig`\<`T`, `string` \| `number`, `TSchema`, `UtilsRecord`, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"syncMode"`\>
14+
- `Omit`\<`BaseCollectionConfig`\<`T`, `string` \| `number`, `TSchema`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>, `any`\>, `"onInsert"` \| `"onUpdate"` \| `"onDelete"` \| `"syncMode"`\>
1515

1616
## Type Parameters
1717

@@ -35,7 +35,7 @@ The schema type for validation
3535
optional [ELECTRIC_TEST_HOOKS]: ElectricTestHooks;
3636
```
3737

38-
Defined in: [packages/electric-db-collection/src/electric.ts:141](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L141)
38+
Defined in: [packages/electric-db-collection/src/electric.ts:147](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L147)
3939

4040
Internal test hooks (for testing only)
4141
Hidden via Symbol to prevent accidental usage in production
@@ -48,15 +48,15 @@ Hidden via Symbol to prevent accidental usage in production
4848
optional onDelete: (params) => Promise<MatchingStrategy>;
4949
```
5050

51-
Defined in: [packages/electric-db-collection/src/electric.ts:246](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L246)
51+
Defined in: [packages/electric-db-collection/src/electric.ts:264](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L264)
5252

5353
Optional asynchronous handler function called before a delete operation
5454

5555
#### Parameters
5656

5757
##### params
5858

59-
`DeleteMutationFnParams`\<`T`\>
59+
`DeleteMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\>
6060

6161
Object containing transaction and collection information
6262

@@ -100,15 +100,15 @@ onDelete: async ({ transaction, collection }) => {
100100
optional onInsert: (params) => Promise<MatchingStrategy>;
101101
```
102102

103-
Defined in: [packages/electric-db-collection/src/electric.ts:189](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L189)
103+
Defined in: [packages/electric-db-collection/src/electric.ts:195](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L195)
104104

105105
Optional asynchronous handler function called before an insert operation
106106

107107
#### Parameters
108108

109109
##### params
110110

111-
`InsertMutationFnParams`\<`T`\>
111+
`InsertMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\>
112112

113113
Object containing transaction and collection information
114114

@@ -174,15 +174,15 @@ onInsert: async ({ transaction, collection }) => {
174174
optional onUpdate: (params) => Promise<MatchingStrategy>;
175175
```
176176

177-
Defined in: [packages/electric-db-collection/src/electric.ts:218](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L218)
177+
Defined in: [packages/electric-db-collection/src/electric.ts:230](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L230)
178178

179179
Optional asynchronous handler function called before an update operation
180180

181181
#### Parameters
182182

183183
##### params
184184

185-
`UpdateMutationFnParams`\<`T`\>
185+
`UpdateMutationFnParams`\<`T`, `string` \| `number`, [`ElectricCollectionUtils`](../ElectricCollectionUtils.md)\<`T`\>\>
186186

187187
Object containing transaction and collection information
188188

@@ -227,7 +227,7 @@ onUpdate: async ({ transaction, collection }) => {
227227
shapeOptions: ShapeStreamOptions<GetExtensions<T>>;
228228
```
229229

230-
Defined in: [packages/electric-db-collection/src/electric.ts:134](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L134)
230+
Defined in: [packages/electric-db-collection/src/electric.ts:140](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L140)
231231

232232
Configuration options for the ElectricSQL ShapeStream
233233

@@ -239,4 +239,4 @@ Configuration options for the ElectricSQL ShapeStream
239239
optional syncMode: ElectricSyncMode;
240240
```
241241

242-
Defined in: [packages/electric-db-collection/src/electric.ts:135](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L135)
242+
Defined in: [packages/electric-db-collection/src/electric.ts:141](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L141)

docs/reference/electric-db-collection/interfaces/ElectricCollectionUtils.md

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

66
# Interface: ElectricCollectionUtils\<T\>
77

8-
Defined in: [packages/electric-db-collection/src/electric.ts:385](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L385)
8+
Defined in: [packages/electric-db-collection/src/electric.ts:409](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L409)
99

1010
Electric collection utilities type
1111

@@ -33,7 +33,7 @@ Electric collection utilities type
3333
awaitMatch: AwaitMatchFn<T>;
3434
```
3535

36-
Defined in: [packages/electric-db-collection/src/electric.ts:389](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L389)
36+
Defined in: [packages/electric-db-collection/src/electric.ts:413](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L413)
3737

3838
***
3939

@@ -43,4 +43,4 @@ Defined in: [packages/electric-db-collection/src/electric.ts:389](https://github
4343
awaitTxId: AwaitTxIdFn;
4444
```
4545

46-
Defined in: [packages/electric-db-collection/src/electric.ts:388](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L388)
46+
Defined in: [packages/electric-db-collection/src/electric.ts:412](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L412)

docs/reference/electric-db-collection/type-aliases/AwaitTxIdFn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: AwaitTxIdFn
99
type AwaitTxIdFn = (txId, timeout?) => Promise<boolean>;
1010
```
1111

12-
Defined in: [packages/electric-db-collection/src/electric.ts:372](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L372)
12+
Defined in: [packages/electric-db-collection/src/electric.ts:396](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L396)
1313

1414
Type for the awaitTxId utility function
1515

docs/reference/functions/createArrayChangeProxy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: createArrayChangeProxy
99
function createArrayChangeProxy<T>(targets): object;
1010
```
1111

12-
Defined in: [packages/db/src/proxy.ts:1115](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L1115)
12+
Defined in: [packages/db/src/proxy.ts:1130](https://github.com/TanStack/db/blob/main/packages/db/src/proxy.ts#L1130)
1313

1414
Creates proxies for an array of objects and tracks changes to each
1515

0 commit comments

Comments
 (0)