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

createLiveQueryWindowController.md

42 lines1.0 KB

1---
2id: createLiveQueryWindowController
3title: createLiveQueryWindowController
4---
5​
6# Function: createLiveQueryWindowController()
7​
8```ts
9function createLiveQueryWindowController<T, TKey>(collection, options): LiveQueryWindowController<T, TKey>;
10```
11​
12Defined in: [packages/db/src/live-query-window-controller.ts:1016](https://github.com/TanStack/db/blob/main/packages/db/src/live-query-window-controller.ts#L1016)
13​
14**`Internal`**
15​
16Create an internal forward-window controller for an ordered live query.
17​
18 This factory is unstable while RFC #1623 is being implemented.
19​
20## Type Parameters
21​
22### T
23​
24`T` *extends* `object`
25​
26### TKey
27​
28`TKey` *extends* `string` \| `number`
29​
30## Parameters
31​
32### collection
33​
34[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `any`, `StandardSchemaV1`\<`unknown`, `unknown`\>, `T`\> | `null` | `undefined`
35​
36### options
37​
38[`CreateLiveQueryWindowControllerOptions`](../interfaces/CreateLiveQueryWindowControllerOptions.md) = `{}`
39​
40## Returns
41​
42[`LiveQueryWindowController`](../interfaces/LiveQueryWindowController.md)\<`T`, `TKey`\>