Skip to content

Fixed docs for storage #7010

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.

Sign up for GitHub

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 1 commit into from
Feb 6, 2023
Merged

Fixed docs for storage #7010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 packages/firebase/compat/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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;
Expand All @@ -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;
/**
Expand Down
4 changes: 2 additions & 2 deletions packages/storage-types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
/**
Expand Down
8 changes: 4 additions & 4 deletions packages/storage/src/implementation/error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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;
Expand All @@ -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
Expand Down