Skip to content

chore: Enabled tsdoc error checking #1459

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 14, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/app-check/token-generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,10 @@ export class AppCheckTokenGenerator {
}

/**
* Creates a new FirebaseAppCheckError by extracting the error code, message and other relevant
* details from a CryptoSignerError.
* Creates a new `FirebaseAppCheckError` by extracting the error code, message and other relevant
* details from a `CryptoSignerError`.
*
* @param err - The Error to convert into a FirebaseAppCheckError error
* @param err - The Error to convert into a `FirebaseAppCheckError` error
* @returns A Firebase App Check error that can be returned to the user.
*/
export function appCheckErrorFromCryptoSignerError(err: Error): Error {
Expand Down
2 changes: 1 addition & 1 deletion src/app/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export interface FirebaseError {
* A string value containing the execution backtrace when the error originally
* occurred.
*
* This information can be useful to you and can be sent to
* This information can be useful for troubleshooting the cause of the error with
* {@link https://firebase.google.com/support | Firebase Support} to help
* explain the cause of an error.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/auth/user-record.ts
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ export class UserInfo {


/**
* @param response - The server side response returned from the getAccountInfo
* @param response - The server side response returned from the `getAccountInfo`
* endpoint.
* @constructor
* @internal
Expand Down