Skip to content

Commit 9442a4b

Browse files
docs: regenerate API documentation
1 parent d17f2e7 commit 9442a4b

54 files changed

Lines changed: 482 additions & 223 deletions

Some content is hidden

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

docs/reference/classes/CollectionImpl.md

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ title: electricCollectionOptions
1111
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:427](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L427)
14+
Defined in: [packages/electric-db-collection/src/electric.ts:474](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L474)
1515

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

@@ -43,7 +43,7 @@ Collection options with utilities
4343
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:438](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L438)
46+
Defined in: [packages/electric-db-collection/src/electric.ts:485](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L485)
4747

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
id: isChangeMessage
3+
title: isChangeMessage
4+
---
5+
6+
# Function: isChangeMessage()
7+
8+
```ts
9+
function isChangeMessage<T>(message): message is ChangeMessage<T>;
10+
```
11+
12+
Defined in: node\_modules/.pnpm/@electric-sql+client@1.2.0/node\_modules/@electric-sql/client/dist/index.d.ts:783
13+
14+
Type guard for checking Message is ChangeMessage.
15+
16+
See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
17+
for information on how to use type guards.
18+
19+
## Type Parameters
20+
21+
### T
22+
23+
`T` *extends* `Row`\<`unknown`\> = `Row`\<`never`\>
24+
25+
## Parameters
26+
27+
### message
28+
29+
`Message`\<`T`\>
30+
31+
the message to check
32+
33+
## Returns
34+
35+
`message is ChangeMessage<T>`
36+
37+
true if the message is a ChangeMessage
38+
39+
## Example
40+
41+
```ts
42+
if (isChangeMessage(message)) {
43+
const msgChng: ChangeMessage = message // Ok
44+
const msgCtrl: ControlMessage = message // Err, type mismatch
45+
}
46+
```
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
id: isControlMessage
3+
title: isControlMessage
4+
---
5+
6+
# Function: isControlMessage()
7+
8+
```ts
9+
function isControlMessage<T>(message): message is ControlMessage;
10+
```
11+
12+
Defined in: node\_modules/.pnpm/@electric-sql+client@1.2.0/node\_modules/@electric-sql/client/dist/index.d.ts:801
13+
14+
Type guard for checking Message is ControlMessage.
15+
16+
See [TS docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
17+
for information on how to use type guards.
18+
19+
## Type Parameters
20+
21+
### T
22+
23+
`T` *extends* `Row`\<`unknown`\> = `Row`\<`never`\>
24+
25+
## Parameters
26+
27+
### message
28+
29+
`Message`\<`T`\>
30+
31+
the message to check
32+
33+
## Returns
34+
35+
`message is ControlMessage`
36+
37+
true if the message is a ControlMessage
38+
39+
*
40+
41+
## Example
42+
43+
```ts
44+
if (isControlMessage(message)) {
45+
const msgChng: ChangeMessage = message // Err, type mismatch
46+
const msgCtrl: ControlMessage = message // Ok
47+
}
48+
```

docs/reference/electric-db-collection/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,5 @@ title: "@tanstack/electric-db-collection"
2626
## Functions
2727

2828
- [electricCollectionOptions](functions/electricCollectionOptions.md)
29+
- [isChangeMessage](functions/isChangeMessage.md)
30+
- [isControlMessage](functions/isControlMessage.md)

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:409](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L409)
8+
Defined in: [packages/electric-db-collection/src/electric.ts:456](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L456)
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:413](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L413)
36+
Defined in: [packages/electric-db-collection/src/electric.ts:460](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L460)
3737

3838
***
3939

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

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)
46+
Defined in: [packages/electric-db-collection/src/electric.ts:459](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L459)

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:396](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L396)
12+
Defined in: [packages/electric-db-collection/src/electric.ts:443](https://github.com/TanStack/db/blob/main/packages/electric-db-collection/src/electric.ts#L443)
1313

1414
Type for the awaitTxId utility function
1515

docs/reference/functions/isLimitSubset.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ title: isLimitSubset
99
function isLimitSubset(subset, superset): boolean;
1010
```
1111

12-
Defined in: [packages/db/src/query/predicate-utils.ts:768](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L768)
12+
Defined in: [packages/db/src/query/predicate-utils.ts:771](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L771)
1313

1414
Check if one limit is a subset of another.
1515
Returns true if the subset limit requirements are satisfied by the superset limit.
1616

17+
Note: This function does NOT consider offset. For offset-aware subset checking,
18+
use `isOffsetLimitSubset` instead.
19+
1720
## Parameters
1821

1922
### subset
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
id: isOffsetLimitSubset
3+
title: isOffsetLimitSubset
4+
---
5+
6+
# Function: isOffsetLimitSubset()
7+
8+
```ts
9+
function isOffsetLimitSubset(subset, superset): boolean;
10+
```
11+
12+
Defined in: [packages/db/src/query/predicate-utils.ts:811](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L811)
13+
14+
Check if one offset+limit range is a subset of another.
15+
Returns true if the subset range is fully contained within the superset range.
16+
17+
A query with `{limit: 10, offset: 0}` loads rows [0, 10).
18+
A query with `{limit: 10, offset: 20}` loads rows [20, 30).
19+
20+
For subset to be satisfied by superset:
21+
- Superset must start at or before subset (superset.offset <= subset.offset)
22+
- Superset must end at or after subset (superset.offset + superset.limit >= subset.offset + subset.limit)
23+
24+
## Parameters
25+
26+
### subset
27+
28+
The offset+limit requirements to check
29+
30+
#### limit?
31+
32+
`number`
33+
34+
#### offset?
35+
36+
`number`
37+
38+
### superset
39+
40+
The offset+limit that might satisfy the requirements
41+
42+
#### limit?
43+
44+
`number`
45+
46+
#### offset?
47+
48+
`number`
49+
50+
## Returns
51+
52+
`boolean`
53+
54+
true if subset range is fully contained within superset range
55+
56+
## Example
57+
58+
```ts
59+
isOffsetLimitSubset({ offset: 0, limit: 5 }, { offset: 0, limit: 10 }) // true
60+
isOffsetLimitSubset({ offset: 5, limit: 5 }, { offset: 0, limit: 10 }) // true (rows 5-9 within 0-9)
61+
isOffsetLimitSubset({ offset: 5, limit: 10 }, { offset: 0, limit: 10 }) // false (rows 5-14 exceed 0-9)
62+
isOffsetLimitSubset({ offset: 20, limit: 10 }, { offset: 0, limit: 10 }) // false (rows 20-29 outside 0-9)
63+
```

docs/reference/functions/isPredicateSubset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ title: isPredicateSubset
99
function isPredicateSubset(subset, superset): boolean;
1010
```
1111

12-
Defined in: [packages/db/src/query/predicate-utils.ts:801](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L801)
12+
Defined in: [packages/db/src/query/predicate-utils.ts:854](https://github.com/TanStack/db/blob/main/packages/db/src/query/predicate-utils.ts#L854)
1313

14-
Check if one predicate (where + orderBy + limit) is a subset of another.
14+
Check if one predicate (where + orderBy + limit + offset) is a subset of another.
1515
Returns true if all aspects of the subset predicate are satisfied by the superset.
1616

1717
## Parameters

0 commit comments

Comments
 (0)