Skip to content

Commit f30f95b

Browse files
update docs with origin
1 parent 5301001 commit f30f95b

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/reference/powersync-db-collection/classes/PowerSyncTransactor.md

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

66
# Class: PowerSyncTransactor
77

8-
Defined in: [PowerSyncTransactor.ts:54](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L54)
8+
Defined in: [PowerSyncTransactor.ts:54](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L54)
99

1010
Applies mutations to the PowerSync database. This method is called automatically by the collection's
1111
insert, update, and delete operations. You typically don't need to call this directly unless you
@@ -51,7 +51,7 @@ The transaction containing mutations to apply
5151
new PowerSyncTransactor(options): PowerSyncTransactor;
5252
```
5353

54-
Defined in: [PowerSyncTransactor.ts:58](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L58)
54+
Defined in: [PowerSyncTransactor.ts:58](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L58)
5555

5656
#### Parameters
5757

@@ -71,7 +71,7 @@ Defined in: [PowerSyncTransactor.ts:58](https://github.com/powersync-ja/temp-tan
7171
database: AbstractPowerSyncDatabase;
7272
```
7373

74-
Defined in: [PowerSyncTransactor.ts:55](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L55)
74+
Defined in: [PowerSyncTransactor.ts:55](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L55)
7575

7676
***
7777

@@ -81,7 +81,7 @@ Defined in: [PowerSyncTransactor.ts:55](https://github.com/powersync-ja/temp-tan
8181
pendingOperationStore: PendingOperationStore;
8282
```
8383

84-
Defined in: [PowerSyncTransactor.ts:56](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L56)
84+
Defined in: [PowerSyncTransactor.ts:56](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L56)
8585

8686
## Methods
8787

@@ -91,7 +91,7 @@ Defined in: [PowerSyncTransactor.ts:56](https://github.com/powersync-ja/temp-tan
9191
applyTransaction(transaction): Promise<void>;
9292
```
9393

94-
Defined in: [PowerSyncTransactor.ts:66](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L66)
94+
Defined in: [PowerSyncTransactor.ts:66](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L66)
9595

9696
Persists a Transaction to the PowerSync SQLite database.
9797

@@ -113,7 +113,7 @@ Persists a Transaction to the PowerSync SQLite database.
113113
protected getMutationCollectionMeta(mutation): PowerSyncCollectionMeta<any>;
114114
```
115115

116-
Defined in: [PowerSyncTransactor.ts:294](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L294)
116+
Defined in: [PowerSyncTransactor.ts:294](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L294)
117117

118118
#### Parameters
119119

@@ -136,7 +136,7 @@ protected handleDelete(
136136
waitForCompletion): Promise<PendingOperation | null>;
137137
```
138138

139-
Defined in: [PowerSyncTransactor.ts:221](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L221)
139+
Defined in: [PowerSyncTransactor.ts:221](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L221)
140140

141141
#### Parameters
142142

@@ -167,7 +167,7 @@ protected handleInsert(
167167
waitForCompletion): Promise<PendingOperation | null>;
168168
```
169169

170-
Defined in: [PowerSyncTransactor.ts:152](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L152)
170+
Defined in: [PowerSyncTransactor.ts:152](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L152)
171171

172172
#### Parameters
173173

@@ -199,7 +199,7 @@ protected handleOperationWithCompletion(
199199
handler): Promise<PendingOperation | null>;
200200
```
201201

202-
Defined in: [PowerSyncTransactor.ts:263](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L263)
202+
Defined in: [PowerSyncTransactor.ts:263](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L263)
203203

204204
Helper function which wraps a persistence operation by:
205205
- Fetching the mutation's collection's SQLite table details
@@ -239,7 +239,7 @@ protected handleUpdate(
239239
waitForCompletion): Promise<PendingOperation | null>;
240240
```
241241

242-
Defined in: [PowerSyncTransactor.ts:187](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L187)
242+
Defined in: [PowerSyncTransactor.ts:187](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L187)
243243

244244
#### Parameters
245245

@@ -267,7 +267,7 @@ Defined in: [PowerSyncTransactor.ts:187](https://github.com/powersync-ja/temp-ta
267267
protected processMutationMetadata(mutation): string | null;
268268
```
269269

270-
Defined in: [PowerSyncTransactor.ts:313](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L313)
270+
Defined in: [PowerSyncTransactor.ts:313](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L313)
271271

272272
Processes collection mutation metadata for persistence to the database.
273273
We only support storing string metadata.

docs/reference/powersync-db-collection/type-aliases/EnhancedPowerSyncCollectionConfig.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: EnhancedPowerSyncCollectionConfig
99
type EnhancedPowerSyncCollectionConfig<TTable, OutputType, TSchema> = CollectionConfig<OutputType, string, TSchema> & object;
1010
```
1111

12-
Defined in: [definitions.ts:259](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L259)
12+
Defined in: [definitions.ts:259](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L259)
1313

1414
A CollectionConfig which includes utilities for PowerSync.
1515

docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionMeta.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: PowerSyncCollectionMeta
99
type PowerSyncCollectionMeta<TTable> = object;
1010
```
1111

12-
Defined in: [definitions.ts:235](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L235)
12+
Defined in: [definitions.ts:235](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L235)
1313

1414
Metadata for the PowerSync Collection.
1515

@@ -27,7 +27,7 @@ Metadata for the PowerSync Collection.
2727
metadataIsTracked: boolean;
2828
```
2929

30-
Defined in: [definitions.ts:253](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L253)
30+
Defined in: [definitions.ts:253](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L253)
3131

3232
Whether the PowerSync table tracks metadata.
3333

@@ -39,7 +39,7 @@ Whether the PowerSync table tracks metadata.
3939
serializeValue: (value) => ExtractedTable<TTable>;
4040
```
4141

42-
Defined in: [definitions.ts:248](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L248)
42+
Defined in: [definitions.ts:248](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L248)
4343

4444
Serializes a collection value to the SQLite type
4545

@@ -61,7 +61,7 @@ Serializes a collection value to the SQLite type
6161
tableName: string;
6262
```
6363

64-
Defined in: [definitions.ts:239](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L239)
64+
Defined in: [definitions.ts:239](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L239)
6565

6666
The SQLite table representing the collection.
6767

@@ -73,6 +73,6 @@ The SQLite table representing the collection.
7373
trackedTableName: string;
7474
```
7575

76-
Defined in: [definitions.ts:243](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L243)
76+
Defined in: [definitions.ts:243](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L243)
7777

7878
The internal table used to track diffs for the collection.

docs/reference/powersync-db-collection/type-aliases/PowerSyncCollectionUtils.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: PowerSyncCollectionUtils
99
type PowerSyncCollectionUtils<TTable> = object;
1010
```
1111

12-
Defined in: [definitions.ts:272](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L272)
12+
Defined in: [definitions.ts:272](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L272)
1313

1414
Collection-level utilities for PowerSync.
1515

@@ -27,7 +27,7 @@ Collection-level utilities for PowerSync.
2727
getMeta: () => PowerSyncCollectionMeta<TTable>;
2828
```
2929

30-
Defined in: [definitions.ts:273](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L273)
30+
Defined in: [definitions.ts:273](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L273)
3131

3232
#### Returns
3333

docs/reference/powersync-db-collection/type-aliases/TransactorOptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: TransactorOptions
99
type TransactorOptions = object;
1010
```
1111

12-
Defined in: [PowerSyncTransactor.ts:15](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L15)
12+
Defined in: [PowerSyncTransactor.ts:15](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L15)
1313

1414
## Properties
1515

@@ -19,4 +19,4 @@ Defined in: [PowerSyncTransactor.ts:15](https://github.com/powersync-ja/temp-tan
1919
database: AbstractPowerSyncDatabase;
2020
```
2121

22-
Defined in: [PowerSyncTransactor.ts:16](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L16)
22+
Defined in: [PowerSyncTransactor.ts:16](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/PowerSyncTransactor.ts#L16)

docs/reference/powersync-db-collection/variables/DEFAULT_BATCH_SIZE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ title: DEFAULT_BATCH_SIZE
99
const DEFAULT_BATCH_SIZE: 1000 = 1000;
1010
```
1111

12-
Defined in: [definitions.ts:279](https://github.com/powersync-ja/temp-tanstack-db/blob/main/packages/powersync-db-collection/src/definitions.ts#L279)
12+
Defined in: [definitions.ts:279](https://github.com/TanStack/db/blob/main/packages/powersync-db-collection/src/definitions.ts#L279)
1313

1414
Default value for [PowerSyncCollectionConfig#syncBatchSize](../type-aliases/BasePowerSyncCollectionConfig.md).

0 commit comments

Comments
 (0)