Open History to see the last commit
1---
2id: Subscription
3title: Subscription
4---
5
6Defined in: [packages/db/src/types.ts:284](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L284)
7
8Public interface for a collection subscription
9Used by sync implementations to track subscription lifecycle
10
11## Extends
12
13- `EventEmitter`\<[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\>
14
15## Properties
16
17### lastError
18
19```ts
20readonly lastError: unknown;
21```
22
23Defined in: [packages/db/src/types.ts:288](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L288)
24
25Most recent subset-load failure observed by this subscription.
26
27***
28
29### status
30
31```ts
32readonly status: SubscriptionStatus;
33```
34
35Defined in: [packages/db/src/types.ts:286](https://github.com/TanStack/db/blob/main/packages/db/src/types.ts#L286)
36
37Current status of the subscription
38
39## Methods
40
41### clearListeners()
42
43```ts
44protected clearListeners(): void;
45```
46
47Defined in: [packages/db/src/event-emitter.ts:156](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L156)
48
49Clear all listeners
50
51#### Returns
52
53`void`
54
55#### Inherited from
56
57```ts
58EventEmitter.clearListeners
59```
60
61***
62
63### emitInner()
64
65```ts
66protected emitInner<T>(event, eventPayload): void;
67```
68
69Defined in: [packages/db/src/event-emitter.ts:124](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L124)
70
71**`Internal`**
72
73Emit an event to all listeners
74
75#### Type Parameters
76
77##### T
78
79`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
80
81#### Parameters
82
83##### event
84
85`T`
86
87Event name to emit
88
89##### eventPayload
90
91[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\[`T`\]
92
93Event payload
94 For use by subclasses - subclasses should wrap this with a public emit if needed
95
96#### Returns
97
98`void`
99
100#### Inherited from
101
102```ts
103EventEmitter.emitInner
104```
105
106***
107
108### emitInnerWhile()
109
110```ts
111protected emitInnerWhile<T>(
112 event,
113 eventPayload,
114 isCurrent): void;
115```
116
117Defined in: [packages/db/src/event-emitter.ts:132](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L132)
118
119Emit until a reentrant callback invalidates the event being delivered.
120
121#### Type Parameters
122
123##### T
124
125`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
126
127#### Parameters
128
129##### event
130
131`T`
132
133##### eventPayload
134
135[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\[`T`\]
136
137##### isCurrent
138
139() => `boolean`
140
141#### Returns
142
143`void`
144
145#### Inherited from
146
147```ts
148EventEmitter.emitInnerWhile
149```
150
151***
152
153### off()
154
155```ts
156off<T>(event, callback): void;
157```
158
159Defined in: [packages/db/src/event-emitter.ts:72](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L72)
160
161Unsubscribe from an event
162
163#### Type Parameters
164
165##### T
166
167`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
168
169#### Parameters
170
171##### event
172
173`T`
174
175Event name to stop listening for
176
177##### callback
178
179(`event`) => `void`
180
181Function to remove
182
183#### Returns
184
185`void`
186
187#### Inherited from
188
189```ts
190EventEmitter.off
191```
192
193***
194
195### on()
196
197```ts
198on<T>(event, callback): () => void;
199```
200
201Defined in: [packages/db/src/event-emitter.ts:21](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L21)
202
203Subscribe to an event
204
205#### Type Parameters
206
207##### T
208
209`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
210
211#### Parameters
212
213##### event
214
215`T`
216
217Event name to listen for
218
219##### callback
220
221(`event`) => `void`
222
223Function to call when event is emitted
224
225#### Returns
226
227Unsubscribe function
228
229```ts
230(): void;
231```
232
233##### Returns
234
235`void`
236
237#### Inherited from
238
239```ts
240EventEmitter.on
241```
242
243***
244
245### once()
246
247```ts
248once<T>(event, callback): () => void;
249```
250
251Defined in: [packages/db/src/event-emitter.ts:50](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L50)
252
253Subscribe to an event once (automatically unsubscribes after first emission)
254
255#### Type Parameters
256
257##### T
258
259`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
260
261#### Parameters
262
263##### event
264
265`T`
266
267Event name to listen for
268
269##### callback
270
271(`event`) => `void`
272
273Function to call when event is emitted
274
275#### Returns
276
277Unsubscribe function
278
279```ts
280(): void;
281```
282
283##### Returns
284
285`void`
286
287#### Inherited from
288
289```ts
290EventEmitter.once
291```
292
293***
294
295### waitFor()
296
297```ts
298waitFor<T>(event, timeout?): Promise<SubscriptionEvents[T]>;
299```
300
301Defined in: [packages/db/src/event-emitter.ts:94](https://github.com/TanStack/db/blob/main/packages/db/src/event-emitter.ts#L94)
302
303Wait for an event to be emitted
304
305#### Type Parameters
306
307##### T
308
309`T` *extends* keyof [`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)
310
311#### Parameters
312
313##### event
314
315`T`
316
317Event name to wait for
318
319##### timeout?
320
321`number`
322
323Optional timeout in milliseconds
324
325#### Returns
326
327`Promise`\<[`SubscriptionEvents`](../type-aliases/SubscriptionEvents.md)\[`T`\]\>
328
329Promise that resolves with the event payload
330
331#### Inherited from
332
333```ts
334EventEmitter.waitFor
335```