Open History to see the last commit
1---
2id: collectionOptions
3title: collectionOptions
4---
5
6# Function: collectionOptions()
7
8## Call Signature
9
10```ts
11function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & NonSingleResult;
12```
13
14Defined in: [packages/db/src/client.ts:180](https://github.com/TanStack/db/blob/main/packages/db/src/client.ts#L180)
15
16### Type Parameters
17
18#### T
19
20`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
21
22#### TKey
23
24`TKey` *extends* `string` \| `number`
25
26#### TUtils
27
28`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
29
30### Parameters
31
32#### options
33
34[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
35
36### Returns
37
38[`CollectionOptions`](../type-aliases/CollectionOptions.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
39
40## Call Signature
41
42```ts
43function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & SingleResult;
44```
45
46Defined in: [packages/db/src/client.ts:189](https://github.com/TanStack/db/blob/main/packages/db/src/client.ts#L189)
47
48### Type Parameters
49
50#### T
51
52`T` *extends* `StandardSchemaV1`\<`unknown`, `unknown`\>
53
54#### TKey
55
56`TKey` *extends* `string` \| `number`
57
58#### TUtils
59
60`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md)
61
62### Parameters
63
64#### options
65
66[`CollectionConfig`](../interfaces/CollectionConfig.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
67
68### Returns
69
70[`CollectionOptions`](../type-aliases/CollectionOptions.md)\<[`InferSchemaOutput`](../type-aliases/InferSchemaOutput.md)\<`T`\>, `TKey`, `T`, `TUtils`\> & [`SingleResult`](../type-aliases/SingleResult.md)
71
72## Call Signature
73
74```ts
75function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<T, TKey, never, TUtils> & NonSingleResult;
76```
77
78Defined in: [packages/db/src/client.ts:198](https://github.com/TanStack/db/blob/main/packages/db/src/client.ts#L198)
79
80### Type Parameters
81
82#### T
83
84`T` *extends* `object`
85
86#### TKey
87
88`TKey` *extends* `string` \| `number` = `string` \| `number`
89
90#### TUtils
91
92`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md)
93
94### Parameters
95
96#### options
97
98[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
99
100### Returns
101
102[`CollectionOptions`](../type-aliases/CollectionOptions.md)\<`T`, `TKey`, `never`, `TUtils`\> & [`NonSingleResult`](../type-aliases/NonSingleResult.md)
103
104## Call Signature
105
106```ts
107function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<T, TKey, never, TUtils> & SingleResult;
108```
109
110Defined in: [packages/db/src/client.ts:207](https://github.com/TanStack/db/blob/main/packages/db/src/client.ts#L207)
111
112### Type Parameters
113
114#### T
115
116`T` *extends* `object`
117
118#### TKey
119
120`TKey` *extends* `string` \| `number` = `string` \| `number`
121
122#### TUtils
123
124`TUtils` *extends* [`UtilsRecord`](../type-aliases/UtilsRecord.md) = [`UtilsRecord`](../type-aliases/UtilsRecord.md)
125
126### Parameters
127
128#### options
129
130[`CollectionConfig`](../interfaces/CollectionConfig.md)\<`T`, `TKey`, `never`, `TUtils`\> & `object` & [`SingleResult`](../type-aliases/SingleResult.md)
131
132### Returns
133
134[`CollectionOptions`](../type-aliases/CollectionOptions.md)\<`T`, `TKey`, `never`, `TUtils`\> & [`SingleResult`](../type-aliases/SingleResult.md)
135
136## Call Signature
137
138```ts
139function collectionOptions<TConfig>(id, factory): DescriptorFromConfig<TConfig>;
140```
141
142Defined in: [packages/db/src/client.ts:216](https://github.com/TanStack/db/blob/main/packages/db/src/client.ts#L216)
143
144### Type Parameters
145
146#### TConfig
147
148`TConfig` *extends* `AnyCollectionConfig`
149
150### Parameters
151
152#### id
153
154`string`
155
156#### factory
157
158(`client`) => `TConfig`
159
160### Returns
161
162`DescriptorFromConfig`\<`TConfig`\>