Open History to see the last commit
1---
2id: createCollection
3title: createCollection
4---
5
6## Call Signature
7
8```ts
9function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & NonSingleResult;
10```
11
12Defined in: [packages/db/src/collection/index.ts:241](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L241)
13
14### Type Parameters
15
16#### T
17
18`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
19
20#### TKey
21
22`TKey` *extends* `string` \| `number`
23
24#### TUtils
25
26`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
27
28### Parameters
29
30#### options
31
32`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
33
34### Returns
35
36[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
37
38## Call Signature
39
40```ts
41function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, Exclude<TUtils, undefined>, T, InferSchemaInput<T>> & NonSingleResult;
42```
43
44Defined in: [packages/db/src/collection/index.ts:258](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L258)
45
46### Type Parameters
47
48#### T
49
50`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
51
52#### TKey
53
54`TKey` *extends* `string` \| `number`
55
56#### TUtils
57
58`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
59
60### Parameters
61
62#### options
63
64[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
65
66### Returns
67
68[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `Exclude`\<`TUtils`, `undefined`\>, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
69
70## Call Signature
71
72```ts
73function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult;
74```
75
76Defined in: [packages/db/src/collection/index.ts:276](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L276)
77
78### Type Parameters
79
80#### T
81
82`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
83
84#### TKey
85
86`TKey` *extends* `string` \| `number`
87
88#### TUtils
89
90`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
91
92### Parameters
93
94#### options
95
96`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
97
98### Returns
99
100[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../type-aliases/SingleResult.md)
101
102## Call Signature
103
104```ts
105function createCollection<T, TKey, TUtils>(options): Collection<InferSchemaOutput<T>, TKey, TUtils, T, InferSchemaInput<T>> & SingleResult;
106```
107
108Defined in: [packages/db/src/collection/index.ts:292](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L292)
109
110### Type Parameters
111
112#### T
113
114`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
115
116#### TKey
117
118`TKey` *extends* `string` \| `number`
119
120#### TUtils
121
122`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
123
124### Parameters
125
126#### options
127
128[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
129
130### Returns
131
132[`Collection`](../interfaces/Collection.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `TUtils`, `T`, [`InferSchemaInput`](../type-aliases/InferSchemaInput.md)\<`T`\>\> & [`SingleResult`](../type-aliases/SingleResult.md)
133
134## Call Signature
135
136```ts
137function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & NonSingleResult;
138```
139
140Defined in: [packages/db/src/collection/index.ts:305](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L305)
141
142### Type Parameters
143
144#### T
145
146`T` *extends* `object`
147
148#### TKey
149
150`TKey` *extends* `string` \| `number`
151
152#### TUtils
153
154`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
155
156### Parameters
157
158#### options
159
160`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
161
162### Returns
163
164[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
165
166## Call Signature
167
168```ts
169function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & NonSingleResult;
170```
171
172Defined in: [packages/db/src/collection/index.ts:318](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L318)
173
174### Type Parameters
175
176#### T
177
178`T` *extends* `object`
179
180#### TKey
181
182`TKey` *extends* `string` \| `number` = `string` \| `number`
183
184#### TUtils
185
186`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md)
187
188### Parameters
189
190#### options
191
192[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
193
194### Returns
195
196[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
197
198## Call Signature
199
200```ts
201function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & SingleResult;
202```
203
204Defined in: [packages/db/src/collection/index.ts:330](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L330)
205
206### Type Parameters
207
208#### T
209
210`T` *extends* `object`
211
212#### TKey
213
214`TKey` *extends* `string` \| `number` = `string` \| `number`
215
216#### TUtils
217
218`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md)
219
220### Parameters
221
222#### options
223
224`Omit`\<[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\>, `"utils"`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
225
226### Returns
227
228[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../type-aliases/SingleResult.md)
229
230## Call Signature
231
232```ts
233function createCollection<T, TKey, TUtils>(options): Collection<T, TKey, TUtils, never, T> & SingleResult;
234```
235
236Defined in: [packages/db/src/collection/index.ts:343](https://github.com/TanStack/db/blob/main/packages/db/src/collection/index.ts#L343)
237
238### Type Parameters
239
240#### T
241
242`T` *extends* `object`
243
244#### TKey
245
246`TKey` *extends* `string` \| `number` = `string` \| `number`
247
248#### TUtils
249
250`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md)
251
252### Parameters
253
254#### options
255
256[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
257
258### Returns
259
260[`Collection`](../interfaces/Collection.md)\<`T`, `TKey`, `TUtils`, `never`, `T`\> & [`SingleResult`](../type-aliases/SingleResult.md)