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

BasicIndexOptions.md

42 lines739 Bytes

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