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

createRealtimeEventEmitter.md

74 lines1.0 KB

1---
2id: createRealtimeEventEmitter
3title: createRealtimeEventEmitter
4---
5​
6# Function: createRealtimeEventEmitter()
7​
8```ts
9function createRealtimeEventEmitter(): object;
10```
11​
12Defined in: [packages/ai/src/realtime/event-emitter.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/event-emitter.ts#L16)
13​
14## Returns
15​
16`object`
17​
18### emit()
19​
20```ts
21emit<TEvent>(event, payload): void;
22```
23​
24#### Type Parameters
25​
26##### TEvent
27​
28`TEvent` *extends* [`RealtimeEvent`](../type-aliases/RealtimeEvent.md)
29​
30#### Parameters
31​
32##### event
33​
34`TEvent`
35​
36##### payload
37​
38[`RealtimeEventPayloads`](../interfaces/RealtimeEventPayloads.md)\[`TEvent`\]
39​
40#### Returns
41​
42`void`
43​
44### on()
45​
46```ts
47on<TEvent>(event, handler): () => void;
48```
49​
50#### Type Parameters
51​
52##### TEvent
53​
54`TEvent` *extends* [`RealtimeEvent`](../type-aliases/RealtimeEvent.md)
55​
56#### Parameters
57​
58##### event
59​
60`TEvent`
61​
62##### handler
63​
64[`RealtimeEventHandler`](../type-aliases/RealtimeEventHandler.md)\<`TEvent`\>
65​
66#### Returns
67​
68```ts
69(): void;
70```
71​
72##### Returns
73​
74`void`