Resolve reviews: typed public AppEmbeddedSDK methods and add documentations for them#147
Conversation
* getUserInfo * getRoomInfo
Codecov Report
@@ Coverage Diff @@
## alpha #147 +/- ##
=======================================
Coverage 59.65% 59.65%
=======================================
Files 73 73
Lines 2377 2377
Branches 350 350
=======================================
Hits 1418 1418
Misses 959 959Continue to review full report at Codecov.
|
graywolf336
left a comment
graywolf336
left a comment
There was a problem hiding this comment.
Would also like to see the class documentation added, that way people can see whether it's for the client or the server alongside the naming convention.
src/client/interfaces/IRoomInfo.ts
Outdated
| @@ -0,0 +1,17 @@ | |||
| import { IUserInfo } from './IUserInfo'; | |||
|
|
|||
| export interface IRoomInfo { | |||
There was a problem hiding this comment.
Let's call these something client side specific, otherwise developers working on the backend/server side could easily get confused as to which one to use.
There was a problem hiding this comment.
Great practice! Learned a lot 😃
src/client/interfaces/IUserInfo.ts
Outdated
| @@ -0,0 +1,14 @@ | |||
| export interface IUserInfo { | |||
There was a problem hiding this comment.
Let's call these something client side specific, otherwise developers working on the backend/server side could easily get confused as to which one to use.
* rename to make sure others can see that it's for client-side * add the class documentation for the AppClientEmbeddedSDK
* Rename to make sure others can see it's for client-side * Add documentation for the IClientRoomInfo and IClientInfo interfaces
graywolf336
left a comment
graywolf336
left a comment
There was a problem hiding this comment.
Awesome, looking forward to this!
2 participants
Resolve: #145 (comment)
Resolve: #145 (comment)
Resolve: #145 (comment)