Adding TypeDoc comments for Auth methods. #530
Merged
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
bojeil-google
suggested changes
May 18, 2019
|
|
||
| /** | ||
| * Returns a JSON-serializable representation of this object. | ||
| */ |
Contributor
There was a problem hiding this comment.
This should have an @return
|
|
||
| /** | ||
| * Returns a JSON-serializable representation of this object. | ||
| */ |
Contributor
There was a problem hiding this comment.
This should have an @return
|
|
||
| /** | ||
| * Returns a JSON-serializable representation of this object. | ||
| */ |
Contributor
There was a problem hiding this comment.
This should have an @return
|
|
||
| /** | ||
| * Returns a JSON-serializable representation of this object. | ||
| */ |
Contributor
There was a problem hiding this comment.
This should have an @return
src/index.d.ts
Outdated
| displayName?: string; | ||
|
|
||
| /** | ||
| * The user's primary phone number, if set.. |
Contributor
There was a problem hiding this comment.
Extra dot at the end.
src/index.d.ts
Outdated
| callbackURL?: string; | ||
|
|
||
| /** | ||
| * |
Contributor
There was a problem hiding this comment.
Same here. I think we can remove this property enableRequestSigning
src/index.d.ts
Outdated
| * samples and detailed documentation. | ||
| * | ||
| * @param properties The properties to set on the | ||
| * new user record to be created. |
Contributor
There was a problem hiding this comment.
fix second line indentation. Note some of these multi-line descriptions can be fit on the same line.
src/index.d.ts
Outdated
| * | ||
| * @param uid The `uid` corresponding to the user to delete. | ||
| * @param properties The properties to update on | ||
| * the provided user. |
src/index.d.ts
Outdated
| * see the [GCIP documentation](https://cloud.google.com/identity-cp). | ||
| * | ||
| * @param options The provider config | ||
| * filter to apply. |
Contributor
There was a problem hiding this comment.
move to previous line
src/index.d.ts
Outdated
| * | ||
| * @param options The provider config | ||
| * filter to apply. | ||
| * @return A promise that |
Contributor
There was a problem hiding this comment.
Next line can probably fit on this line
bojeil-google
suggested changes
May 21, 2019
src/index.d.ts
Outdated
| type UpdateAuthProviderRequest = | ||
| admin.auth.SAMLUpdateAuthProviderRequest | admin.auth.OIDCUpdateAuthProviderRequest; | ||
|
|
||
Contributor
There was a problem hiding this comment.
I meant the spaces on line 1250
src/index.d.ts
Outdated
| * and accepts the Firebase Dynamic Links terms of service. | ||
| * The Android package name and iOS bundle ID are respected only if they | ||
| * are configured in the same Firebase Auth project. | ||
| * @return |
Contributor
There was a problem hiding this comment.
You can safely add my suggestion here:
@return A promise that resolves with the generated link.
src/index.d.ts
Outdated
| /** | ||
| * Defines the dynamic link domain to use for the current link if it is to be | ||
| * opened using Firebase Dynamic Links, as multiple dynamic link domains can be | ||
| * configured per project. This field provides the ability explicitly choose |
Contributor
There was a problem hiding this comment.
This fields provides the ability to explicitly choose...
bojeil-google
approved these changes
May 23, 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. * 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.
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
2 participants
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.
Adding TypeDoc comments for Auth methods, along with related TOC tweaks.
Staged internally at: https://firebase.devsite.corp.google.com/docs/reference/admin/node/admin.auth.Auth
Thanks!