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

createLiveQueryWindowController.md

40 lines1013 Bytes

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