Skip to content

Commit 42fa2a1

Browse files
authored
Fixed docs for storage (#7010)
1 parent ac5cc6e commit 42fa2a1

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

packages/firebase/compat/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8018,7 +8018,7 @@ declare namespace firebase.storage {
80188018
}
80198019

80208020
/**
8021-
* Error codes that can be attached to `StorageError`s.
8021+
* Error codes that can be attached to `StorageError` objects.
80228022
*/
80238023
export enum StorageErrorCode {
80248024
UNKNOWN = 'unknown',
@@ -8053,7 +8053,7 @@ declare namespace firebase.storage {
80538053
*/
80548054
export interface FirebaseStorageError extends FirebaseError {
80558055
/**
8056-
* Stores custom error data unque to StorageError.
8056+
* Stores custom error data unique to the `StorageError`.
80578057
*/
80588058
customData: {
80598059
serverResponse: string | null;
@@ -8062,7 +8062,7 @@ declare namespace firebase.storage {
80628062
get status(): number;
80638063
set status(status: number);
80648064
/**
8065-
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
8065+
* Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
80668066
*/
80678067
_codeEquals(code: StorageErrorCode): boolean;
80688068
/**

packages/storage-types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export enum StorageErrorCode {
127127

128128
export interface FirebaseStorageError extends FirebaseError {
129129
/**
130-
* Stores custom error data unque to StorageError.
130+
* Stores custom error data unique to the `StorageError`.
131131
*/
132132
customData: {
133133
serverResponse: string | null;
@@ -136,7 +136,7 @@ export interface FirebaseStorageError extends FirebaseError {
136136
get status(): number;
137137
set status(status: number);
138138
/**
139-
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
139+
* Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
140140
*/
141141
_codeEquals(code: StorageErrorCode): boolean;
142142
/**

packages/storage/src/implementation/error.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ import { CONFIG_STORAGE_BUCKET_KEY } from './constants';
2626
export class StorageError extends FirebaseError {
2727
private readonly _baseMessage: string;
2828
/**
29-
* Stores custom error data unque to StorageError.
29+
* Stores custom error data unique to the `StorageError`.
3030
*/
3131
customData: { serverResponse: string | null } = { serverResponse: null };
3232

3333
/**
34-
* @param code - A StorageErrorCode string to be prefixed with 'storage/' and
34+
* @param code - A `StorageErrorCode` string to be prefixed with 'storage/' and
3535
* added to the end of the message.
3636
* @param message - Error message.
3737
* @param status_ - Corresponding HTTP Status Code
@@ -56,7 +56,7 @@ export class StorageError extends FirebaseError {
5656
}
5757

5858
/**
59-
* Compares a StorageErrorCode against this error's code, filtering out the prefix.
59+
* Compares a `StorageErrorCode` against this error's code, filtering out the prefix.
6060
*/
6161
_codeEquals(code: StorageErrorCode): boolean {
6262
return prependCode(code) === this.code;
@@ -83,7 +83,7 @@ export const errors = {};
8383

8484
/**
8585
* @public
86-
* Error codes that can be attached to `StorageError`s.
86+
* Error codes that can be attached to `StorageError` objects.
8787
*/
8888
export enum StorageErrorCode {
8989
// Shared between all platforms

0 commit comments

Comments
 (0)