Rename RoomState to ConnectionState #232
Conversation
| /** | ||
| * @deprecated StateChanged has been renamed to ConnectionStateChanged | ||
| */ | ||
| StateChanged = 'connectionStateChanged', |
There was a problem hiding this comment.
with 1.0 change, we could remove this? since it won't be fired anywhere.
There was a problem hiding this comment.
only thing to keep in mind is that if we don't release another version before 1.0 (likely) it will simply break people's apps if they are currently using RoomEvent.StateChanged. Because both events (StateChanged and ConnectionStateChanged) share the same event identifier connectionStateChanged people could still use StateChanged right now and receive events.
But I think it might be ok to remove it as long as we explicitly mention the fix for it in the release notes of 1.0.
There was a problem hiding this comment.
right.. you mean their existing app would fail to compile if they were using this. I guess it's fine if we left it in there until 1.1.
ConnectionStateis more descriptive about what kind of state it actually holds and we already have aRoomStatetype in the livekit-react repo, so this additionally avoids confusion.Old name is just deprecated for now and not yet removed.