Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions docs/reference/classes/BTreeIndex.md

Large diffs are not rendered by default.

80 changes: 40 additions & 40 deletions docs/reference/classes/BaseIndex.md

Large diffs are not rendered by default.

80 changes: 40 additions & 40 deletions docs/reference/classes/BasicIndex.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/reference/interfaces/BTreeRangeQueryOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: BTreeRangeQueryOptions

# Interface: BTreeRangeQueryOptions

Defined in: [packages/db/src/indexes/btree-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L24)
Defined in: [packages/db/src/indexes/btree-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L25)

Options for range queries

Expand All @@ -17,7 +17,7 @@ Options for range queries
optional from: any;
```

Defined in: [packages/db/src/indexes/btree-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L25)
Defined in: [packages/db/src/indexes/btree-index.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L26)

***

Expand All @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:25](https://github.com/TanSt
optional fromInclusive: boolean;
```

Defined in: [packages/db/src/indexes/btree-index.ts:27](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L27)
Defined in: [packages/db/src/indexes/btree-index.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L28)

***

Expand All @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/btree-index.ts:27](https://github.com/TanSt
optional to: any;
```

Defined in: [packages/db/src/indexes/btree-index.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L26)
Defined in: [packages/db/src/indexes/btree-index.ts:27](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L27)

***

Expand All @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/btree-index.ts:26](https://github.com/TanSt
optional toInclusive: boolean;
```

Defined in: [packages/db/src/indexes/btree-index.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L28)
Defined in: [packages/db/src/indexes/btree-index.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/btree-index.ts#L29)
6 changes: 3 additions & 3 deletions docs/reference/interfaces/BasicIndexOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: BasicIndexOptions

# Interface: BasicIndexOptions

Defined in: [packages/db/src/indexes/basic-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L24)
Defined in: [packages/db/src/indexes/basic-index.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L28)

Options for Basic index

Expand All @@ -17,7 +17,7 @@ Options for Basic index
optional compareFn: (a, b) => number;
```

Defined in: [packages/db/src/indexes/basic-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L25)
Defined in: [packages/db/src/indexes/basic-index.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L29)

#### Parameters

Expand All @@ -41,4 +41,4 @@ Defined in: [packages/db/src/indexes/basic-index.ts:25](https://github.com/TanSt
optional compareOptions: CompareOptions;
```

Defined in: [packages/db/src/indexes/basic-index.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L26)
Defined in: [packages/db/src/indexes/basic-index.ts:30](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L30)
52 changes: 26 additions & 26 deletions docs/reference/interfaces/IndexInterface.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: IndexInterface

# Interface: IndexInterface\<TKey\>

Defined in: [packages/db/src/indexes/base-index.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L28)
Defined in: [packages/db/src/indexes/base-index.ts:29](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L29)

## Type Parameters

Expand All @@ -21,7 +21,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:28](https://github.com/TanSta
add: (key, item) => void;
```

Defined in: [packages/db/src/indexes/base-index.ts:31](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L31)
Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L32)

#### Parameters

Expand All @@ -45,7 +45,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:31](https://github.com/TanSta
build: (entries) => void;
```

Defined in: [packages/db/src/indexes/base-index.ts:35](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L35)
Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L36)

#### Parameters

Expand All @@ -65,7 +65,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:35](https://github.com/TanSta
clear: () => void;
```

Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L36)
Defined in: [packages/db/src/indexes/base-index.ts:37](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L37)

#### Returns

Expand All @@ -79,7 +79,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:36](https://github.com/TanSta
equalityLookup: (value) => Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:40](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L40)
Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L41)

#### Parameters

Expand All @@ -99,7 +99,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:40](https://github.com/TanSta
getStats: () => IndexStats;
```

Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L84)
Defined in: [packages/db/src/indexes/base-index.ts:85](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L85)

#### Returns

Expand All @@ -113,7 +113,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:84](https://github.com/TanSta
inArrayLookup: (values) => Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L41)
Defined in: [packages/db/src/indexes/base-index.ts:42](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L42)

#### Parameters

Expand All @@ -133,7 +133,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:41](https://github.com/TanSta
lookup: (operation, value) => Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:38](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L38)
Defined in: [packages/db/src/indexes/base-index.ts:39](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L39)

#### Parameters

Expand All @@ -157,7 +157,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:38](https://github.com/TanSta
matchesCompareOptions: (compareOptions) => boolean;
```

Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L81)
Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L82)

#### Parameters

Expand All @@ -177,7 +177,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanSta
matchesDirection: (direction) => boolean;
```

Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L82)
Defined in: [packages/db/src/indexes/base-index.ts:83](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L83)

#### Parameters

Expand All @@ -197,7 +197,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:82](https://github.com/TanSta
matchesField: (fieldPath) => boolean;
```

Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L80)
Defined in: [packages/db/src/indexes/base-index.ts:81](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L81)

#### Parameters

Expand All @@ -217,7 +217,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:80](https://github.com/TanSta
rangeQuery: (options) => Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L43)
Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L44)

#### Parameters

Expand All @@ -237,7 +237,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:43](https://github.com/TanSta
rangeQueryReversed: (options) => Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L44)
Defined in: [packages/db/src/indexes/base-index.ts:45](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L45)

#### Parameters

Expand All @@ -257,7 +257,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:44](https://github.com/TanSta
remove: (key, item) => void;
```

Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L32)
Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L33)

#### Parameters

Expand All @@ -281,7 +281,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:32](https://github.com/TanSta
supports: (operation) => boolean;
```

Defined in: [packages/db/src/indexes/base-index.ts:69](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L69)
Defined in: [packages/db/src/indexes/base-index.ts:70](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L70)

#### Parameters

Expand All @@ -301,7 +301,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:69](https://github.com/TanSta
take: (n, from, filterFn?) => TKey[];
```

Defined in: [packages/db/src/indexes/base-index.ts:46](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L46)
Defined in: [packages/db/src/indexes/base-index.ts:47](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L47)

#### Parameters

Expand Down Expand Up @@ -329,7 +329,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:46](https://github.com/TanSta
takeFromStart: (n, filterFn?) => TKey[];
```

Defined in: [packages/db/src/indexes/base-index.ts:51](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L51)
Defined in: [packages/db/src/indexes/base-index.ts:52](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L52)

#### Parameters

Expand All @@ -353,7 +353,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:51](https://github.com/TanSta
takeReversed: (n, from, filterFn?) => TKey[];
```

Defined in: [packages/db/src/indexes/base-index.ts:52](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L52)
Defined in: [packages/db/src/indexes/base-index.ts:53](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L53)

#### Parameters

Expand Down Expand Up @@ -381,7 +381,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:52](https://github.com/TanSta
takeReversedFromEnd: (n, filterFn?) => TKey[];
```

Defined in: [packages/db/src/indexes/base-index.ts:57](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L57)
Defined in: [packages/db/src/indexes/base-index.ts:58](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L58)

#### Parameters

Expand All @@ -405,7 +405,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:57](https://github.com/TanSta
update: (key, oldItem, newItem) => void;
```

Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L33)
Defined in: [packages/db/src/indexes/base-index.ts:34](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L34)

#### Parameters

Expand Down Expand Up @@ -435,7 +435,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:33](https://github.com/TanSta
get indexedKeysSet(): Set<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L66)
Defined in: [packages/db/src/indexes/base-index.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L67)

##### Returns

Expand All @@ -451,7 +451,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:66](https://github.com/TanSta
get keyCount(): number;
```

Defined in: [packages/db/src/indexes/base-index.ts:62](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L62)
Defined in: [packages/db/src/indexes/base-index.ts:63](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L63)

##### Returns

Expand All @@ -467,7 +467,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:62](https://github.com/TanSta
get orderedEntriesArray(): [any, Set<TKey>][];
```

Defined in: [packages/db/src/indexes/base-index.ts:63](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L63)
Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L64)

##### Returns

Expand All @@ -483,7 +483,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:63](https://github.com/TanSta
get orderedEntriesArrayReversed(): [any, Set<TKey>][];
```

Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L64)
Defined in: [packages/db/src/indexes/base-index.ts:65](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L65)

##### Returns

Expand All @@ -499,7 +499,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:64](https://github.com/TanSta
get supportsRangeOptimization(): boolean;
```

Defined in: [packages/db/src/indexes/base-index.ts:78](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L78)
Defined in: [packages/db/src/indexes/base-index.ts:79](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L79)

Whether range lookups (gt/gte/lt/lte) on this index can be trusted to
return every matching key. Range traversal relies on the index ordering, so
Expand All @@ -521,7 +521,7 @@ a full scan when this is `false`.
get valueMapData(): Map<any, Set<TKey>>;
```

Defined in: [packages/db/src/indexes/base-index.ts:67](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L67)
Defined in: [packages/db/src/indexes/base-index.ts:68](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L68)

##### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/interfaces/IndexStats.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: IndexStats

# Interface: IndexStats

Defined in: [packages/db/src/indexes/base-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L21)
Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L22)

Statistics about index usage and performance

Expand All @@ -17,7 +17,7 @@ Statistics about index usage and performance
readonly averageLookupTime: number;
```

Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L24)
Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L25)

***

Expand All @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/TanSta
readonly entryCount: number;
```

Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L22)
Defined in: [packages/db/src/indexes/base-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L23)

***

Expand All @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/base-index.ts:22](https://github.com/TanSta
readonly lastUpdated: Date;
```

Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L25)
Defined in: [packages/db/src/indexes/base-index.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L26)

***

Expand All @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/base-index.ts:25](https://github.com/TanSta
readonly lookupCount: number;
```

Defined in: [packages/db/src/indexes/base-index.ts:23](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L23)
Defined in: [packages/db/src/indexes/base-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L24)
10 changes: 5 additions & 5 deletions docs/reference/interfaces/RangeQueryOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: RangeQueryOptions

# Interface: RangeQueryOptions

Defined in: [packages/db/src/indexes/basic-index.ts:14](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L14)
Defined in: [packages/db/src/indexes/basic-index.ts:18](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L18)

Options for range queries

Expand All @@ -17,7 +17,7 @@ Options for range queries
optional from: any;
```

Defined in: [packages/db/src/indexes/basic-index.ts:15](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L15)
Defined in: [packages/db/src/indexes/basic-index.ts:19](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L19)

***

Expand All @@ -27,7 +27,7 @@ Defined in: [packages/db/src/indexes/basic-index.ts:15](https://github.com/TanSt
optional fromInclusive: boolean;
```

Defined in: [packages/db/src/indexes/basic-index.ts:17](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L17)
Defined in: [packages/db/src/indexes/basic-index.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L21)

***

Expand All @@ -37,7 +37,7 @@ Defined in: [packages/db/src/indexes/basic-index.ts:17](https://github.com/TanSt
optional to: any;
```

Defined in: [packages/db/src/indexes/basic-index.ts:16](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L16)
Defined in: [packages/db/src/indexes/basic-index.ts:20](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L20)

***

Expand All @@ -47,4 +47,4 @@ Defined in: [packages/db/src/indexes/basic-index.ts:16](https://github.com/TanSt
optional toInclusive: boolean;
```

Defined in: [packages/db/src/indexes/basic-index.ts:18](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L18)
Defined in: [packages/db/src/indexes/basic-index.ts:22](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L22)
2 changes: 1 addition & 1 deletion docs/reference/type-aliases/IndexConstructor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: IndexConstructor
type IndexConstructor<TKey> = (id, expression, name?, options?) => BaseIndex<TKey>;
```

Defined in: [packages/db/src/indexes/base-index.ts:231](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L231)
Defined in: [packages/db/src/indexes/base-index.ts:234](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/base-index.ts#L234)

Type for index constructor

Expand Down
Loading