Fixed docs for storage (#7010)

firebase · Feb 6, 2023 · 42fa2a1 · 42fa2a1
1 parent ac5cc6e
commit 42fa2a1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/packages/firebase/compat/index.d.ts b/packages/firebase/compat/index.d.ts
@@ -8018,7 +8018,7 @@ declare namespace firebase.storage {
   }
 
   /**
-   * Error codes that can be attached to `StorageError`s.
+   * Error codes that can be attached to `StorageError` objects.
    */
   export enum StorageErrorCode {
     UNKNOWN = 'unknown',
@@ -8053,7 +8053,7 @@ declare namespace firebase.storage {
    */
   export interface FirebaseStorageError extends FirebaseError {
     /**
-     * Stores custom error data unque to StorageError.
+     * Stores custom error data unique to the `StorageError`.
      */
     customData: {
       serverResponse: string | null;
@@ -8062,7 +8062,7 @@ declare namespace firebase.storage {
     get status(): number;
     set status(status: number);
     /**
-     * Compares a StorageErrorCode against this error's code, filtering out the prefix.
+     * Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
      */
     _codeEquals(code: StorageErrorCode): boolean;
     /**

diff --git a/packages/storage-types/index.d.ts b/packages/storage-types/index.d.ts
@@ -127,7 +127,7 @@ export enum StorageErrorCode {
 
 export interface FirebaseStorageError extends FirebaseError {
   /**
-   * Stores custom error data unque to StorageError.
+   * Stores custom error data unique to the `StorageError`.
    */
   customData: {
     serverResponse: string | null;
@@ -136,7 +136,7 @@ export interface FirebaseStorageError extends FirebaseError {
   get status(): number;
   set status(status: number);
   /**
-   * Compares a StorageErrorCode against this error's code, filtering out the prefix.
+   * Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
    */
   _codeEquals(code: StorageErrorCode): boolean;
   /**

diff --git a/packages/storage/src/implementation/error.ts b/packages/storage/src/implementation/error.ts
@@ -26,12 +26,12 @@ import { CONFIG_STORAGE_BUCKET_KEY } from './constants';
 export class StorageError extends FirebaseError {
   private readonly _baseMessage: string;
   /**
-   * Stores custom error data unque to StorageError.
+   * Stores custom error data unique to the `StorageError`.
    */
   customData: { serverResponse: string | null } = { serverResponse: null };
 
   /**
-   * @param code - A StorageErrorCode string to be prefixed with 'storage/' and
+   * @param code - A `StorageErrorCode` string to be prefixed with 'storage/' and
    *  added to the end of the message.
    * @param message  - Error message.
    * @param status_ - Corresponding HTTP Status Code
@@ -56,7 +56,7 @@ export class StorageError extends FirebaseError {
   }
 
   /**
-   * Compares a StorageErrorCode against this error's code, filtering out the prefix.
+   * Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
    */
   _codeEquals(code: StorageErrorCode): boolean {
     return prependCode(code) === this.code;
@@ -83,7 +83,7 @@ export const errors = {};
 
 /**
  * @public
- * Error codes that can be attached to `StorageError`s.
+ * Error codes that can be attached to `StorageError` objects.
  */
 export enum StorageErrorCode {
   // Shared between all platforms