Adding comments for Auth classes and updating TOC #521
Conversation
This file contains hidden or 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
…dmin-node into egilmore-typedoc-src
hiranya911
reviewed
May 7, 2019
There was a problem hiding this comment.
Looks good. Also please share the staged output to see how this looks. I'm also adding @bojeil-google for another look.
src/index.d.ts
Outdated
| @@ -633,6 +1310,9 @@ declare namespace admin.auth { | |||
| ): Promise<admin.auth.AuthProviderConfig>; | |||
| } | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Perhaps this empty block can be removed?
There was a problem hiding this comment.
You bet Hiranya -- staged at https://firebase.devsite.corp.google.com/docs/reference/admin/node/admin.auth.UserRecord.
As you noticed, I should clarify that the Auth methods commenting will come in a separate following pull request. Thanks!
bojeil-google
suggested changes
May 13, 2019
src/index.d.ts
Outdated
| displayName?: string; | ||
|
|
||
| /** | ||
| * The user's primary phone number, if set.. |
src/index.d.ts
Outdated
| interface UpdateRequest { | ||
|
|
||
| /** | ||
| * Whether or not Whether or not the user is disabled: `true` for disabled; |
There was a problem hiding this comment.
"Whether or not" is duplicated.
src/index.d.ts
Outdated
| * Time, in seconds since the Unix epoch, when the end-user authentication | ||
| * occurred. | ||
| * | ||
| * This value is not when this particular ID token was created, but when the |
There was a problem hiding this comment.
Seems like a verb is missing?
This valid is not "set" when...
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * The ID of the provider used to sign in the | ||
| * user. One of `"anonymous"`, `"password"`, `"facebook.com"`, `"github.com"`, |
There was a problem hiding this comment.
This block does not seem to align with the above statement. You have 2 additional spaces.
There was a problem hiding this comment.
this is still not aligned.
src/index.d.ts
Outdated
| sign_in_provider: string; | ||
| [key: string]: any; | ||
| [key: string]: any; |
There was a problem hiding this comment.
Indentation is unnecessary.
src/index.d.ts
Outdated
| uid: string; | ||
| [key: string]: any; | ||
| [key: string]: any; |
There was a problem hiding this comment.
Remove extra indentation
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * An array of providers (for example, Google, Facebook) linked to the user. | ||
| */ | ||
| providerData?: { | ||
| uid: string, | ||
| displayName?: string, | ||
| email?: string, | ||
| photoURL?: string, | ||
| providerId: string, | ||
| }[]; |
There was a problem hiding this comment.
I think we can replace with:
providerData?: admin.auth.UserInfo[];
src/index.d.ts
Outdated
| type UpdateAuthProviderRequest = | ||
| admin.auth.SAMLUpdateAuthProviderRequest | admin.auth.OIDCUpdateAuthProviderRequest; | ||
|
|
||
bojeil-google
suggested changes
May 14, 2019
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * The ID of the provider used to sign in the | ||
| * user. One of `"anonymous"`, `"password"`, `"facebook.com"`, `"github.com"`, |
There was a problem hiding this comment.
this is still not aligned.
bojeil-google
approved these changes
May 14, 2019
hiranya911
pushed a commit
that referenced
this pull request
Jun 5, 2019
* Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue.
egilmorez
added a commit
that referenced
this pull request
Jun 5, 2019
* Getting the typedoc toolchain to run against index.d.ts * Removing unused templates * Adding a npm script * Adding commenting for Admin and Storage. (#510) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding comments for admin.Messaging and a few others. (#516) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Auto-generating links to re-exported Firestore types (#519) * Adding comments for Auth classes and updating TOC (#521) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding TypeDoc comments for Auth methods. (#530) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding comments for Auth methods. * Addressing feedback from bojeil-goole. * Second attempt to view and address *all* comments from bojeil-google. * Removing unnecessary whitespace. * Fixing what we think and hope is the last typo in this pull request. * Credential db (#544) * Adding comments for credential and database classes/methods. * Fixing typo in example. * Adding changes requested by hiranya911. * Fixing a typo. * Fixing the typo fixes. * Adding comments for admin.projectManagement. (#547) * Adding comments for admin.projectManagement. * Fixing misplaced comments for appId metadata. * Merging changes with master. (#553) * Getting the typedoc toolchain to run against index.d.ts * Removing unused templates * Adding a npm script * Adding commenting for Admin and Storage. (#510) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding comments for admin.Messaging and a few others. (#516) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Auto-generating links to re-exported Firestore types (#519) * Adding comments for Auth classes and updating TOC (#521) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding TypeDoc comments for Auth methods. (#530) * Adding commenting for Admin and Storage. * Addressing feedback from hiranya911. * Adding commenting for admin.Messaging and others. * Fixing some issues found by hiranya911. * Adding correct indenting in line 1909. * Adding commmenting for admin.Auth classes and fleshing out TOC. * Making fixes requeted by bojeil-google. * Fixing one last alignment issue. * Adding comments for Auth methods. * Addressing feedback from bojeil-goole. * Second attempt to view and address *all* comments from bojeil-google. * Removing unnecessary whitespace. * Fixing what we think and hope is the last typo in this pull request. * Credential db (#544) * Adding comments for credential and database classes/methods. * Fixing typo in example. * Adding changes requested by hiranya911. * Fixing a typo. * Fixing the typo fixes. * Adding comments for admin.projectManagement. (#547) * Adding comments for admin.projectManagement. * Fixing misplaced comments for appId metadata. * Adding new line to end of file.
This was referenced Jan 1, 2024
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.
After mistakenly creating a pull request into master, I hope to properly push my doc changes into hkj-typedoc :)
Thanks!