Add Comments for methods, classes and interface. #254
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DaKingKong
reviewed
Apr 29, 2024
| @@ -2,31 +2,39 @@ import React, {Component} from 'react'; | |||
|
|
|||
| import {SDK} from '@ringcentral/sdk'; | |||
|
|
|||
| // Utility function to get display name | |||
There was a problem hiding this comment.
What is a display name? Who's name? A user? A service? Or something else
| const delay = () => new Promise(res => setTimeout(res, 0)); | ||
|
|
||
| // Interface for the state of AuthGate component |
| export interface AuthGateState { | ||
| isAuthorized: boolean; | ||
| authorizing: boolean; | ||
| authError: null | Error; | ||
| } | ||
|
|
||
| // Interface for the render props provided by AuthGate |
| export interface AuthGateRenderProps extends AuthGateState { | ||
| loginUrl: (options: any) => string; | ||
| parseRedirect: (search: string) => Promise<any>; | ||
| logout: () => Promise<any>; | ||
| } | ||
|
|
||
| // Interface for the props of AuthGate component |
| export interface AuthGateProps { | ||
| sdk: SDK; | ||
| ensure?: boolean; | ||
| children: (props: AuthGateRenderProps) => any; | ||
| } | ||
|
|
||
| // AuthGate component definition |
There was a problem hiding this comment.
What does AuthGate do in general?
| public before = () => this.mounted && this.setState({authorizing: true}); | ||
|
|
||
| // Handler for error event |
There was a problem hiding this comment.
What does this do in the handler?
| public error = async e => this.updateState(e); | ||
|
|
||
| // Handler for success event |
There was a problem hiding this comment.
What does this do in the handler?
| public success = async () => this.updateState(null); | ||
|
|
||
| // Method to get login URL |
| @@ -107,6 +123,7 @@ export class AuthGate extends Component<AuthGateProps, AuthGateState> { | |||
| } | |||
| }; | |||
|
|
|||
| // Method to update state | |||
There was a problem hiding this comment.
Need more description of this method. This looks a bit like an unauth, which is confusing. Why is authorizing set to false?
| @@ -120,6 +137,7 @@ export class AuthGate extends Component<AuthGateProps, AuthGateState> { | |||
| }); | |||
| }; | |||
|
|
|||
| // Render method | |||
There was a problem hiding this comment.
Not this one, but the one below if you expand the hidden code for Line 153 ~162.
There's a clear comment saying TODO Definition there. That's a very clear sign that we want to add its definition there.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.