Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

BasicIndexOptions.md

44 lines771 Bytes

1---
2id: BasicIndexOptions
3title: BasicIndexOptions
4---
5​
6# Interface: BasicIndexOptions
7​
8Defined in: [packages/db/src/indexes/basic-index.ts:24](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L24)
9​
10Options for Basic index
11​
12## Properties
13​
14### compareFn()?
15​
16```ts
17optional compareFn: (a, b) => number;
18```
19​
20Defined in: [packages/db/src/indexes/basic-index.ts:25](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L25)
21​
22#### Parameters
23​
24##### a
25​
26`any`
27​
28##### b
29​
30`any`
31​
32#### Returns
33​
34`number`
35​
36***
37​
38### compareOptions?
39​
40```ts
41optional compareOptions: CompareOptions;
42```
43​
44Defined in: [packages/db/src/indexes/basic-index.ts:26](https://github.com/TanStack/db/blob/main/packages/db/src/indexes/basic-index.ts#L26)