Skip to content

Commit 1ab7d52

Browse files
committed
docs(collaboration): remove incorrect constructorParams from examples
The ActorRegistration interface doesn't have a constructorParams field. Actors are initialized via actions after registration, as shown in the actual working demo code.
1 parent bd4f309 commit 1ab7d52

File tree

2 files changed

+11
-12
lines changed

2 files changed

+11
-12
lines changed

packages/collaboration/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -94,20 +94,17 @@ const system = new ActorSystem();
9494
system.register({
9595
token: WebSocketToken,
9696
actor: WebSocketActor,
97-
constructorParams: { url: 'http://localhost:3000', roomId: 'my-room' }
9897
});
9998

10099
system.register({
101-
token: PeerMessagingToken,
102-
actor: PeerMessagingActor,
103-
dependencies: { websocket: WebSocketToken, webrtc: WebRTCToken }
100+
token: WebRTCToken,
101+
actor: WebRTCActor,
104102
});
105103

106104
system.register({
107-
token: WebRTCToken,
108-
actor: WebRTCActor,
109-
constructorParams: { SimplePeer, peerId: 'my-peer-id' },
110-
dependencies: { peerMessaging: PeerMessagingToken }
105+
token: PeerMessagingToken,
106+
actor: PeerMessagingActor,
107+
dependencies: { websocket: WebSocketToken, webrtc: WebRTCToken }
111108
});
112109

113110
system.register({
@@ -118,9 +115,12 @@ system.register({
118115

119116
await system.start();
120117

121-
// 4. Connect to start collaborating
122-
const websocket = system.get(WebSocketToken);
123-
websocket.actions.connect();
118+
// 4. Initialize WebSocket connection
119+
const websocket = system.getClient(WebSocketToken);
120+
websocket?.actions.initialize({
121+
url: 'http://localhost:3001',
122+
roomId: 'demo-room'
123+
});
124124
```
125125

126126
## React Integration

packages/collaboration/examples/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,6 @@ const WebRTCToken = createActorToken<WebRTCActor>('webrtc');
193193
system.register({
194194
token: WebRTCToken,
195195
actor: WebRTCActor,
196-
constructorParams: { SimplePeer, peerId: clientName },
197196
dependencies: { peerMessaging: PeerMessagingToken }
198197
});
199198

0 commit comments

Comments
 (0)