@firebase/storage

constructor

constructor(code: StorageErrorCode, message: string, status_?: number);

• Parameter code

  A StorageErrorCode string to be prefixed with 'storage/' and added to the end of the message.

  Parameter message

  Error message.

  Parameter status_

  Corresponding HTTP Status Code

property customData

customData: { serverResponse: string | null };

• Stores custom error data unique to the StorageError.

property serverResponse

serverResponse: string;

• Optional response message that was added by the server.

property status

status: number;

property app

readonly app: FirebaseApp;

• The @firebase/app#FirebaseApp associated with this FirebaseStorage instance.

property maxOperationRetryTime

maxOperationRetryTime: number;

• The maximum time to retry operations other than uploads or downloads in milliseconds.

property maxUploadRetryTime

maxUploadRetryTime: number;

• The maximum time to retry uploads in milliseconds.

property bucket

bucket: string;

• The bucket this object is contained in.

property downloadTokens

downloadTokens: string[] | undefined;

• Tokens to allow access to the downloatd URL.

property fullPath

fullPath: string;

• The full path of this object.

property generation

generation: string;

• The object's generation. https://cloud.google.com/storage/docs/metadata#generation-number

property metageneration

metageneration: string;

• The object's metageneration. https://cloud.google.com/storage/docs/metadata#generation-number

property name

name: string;

• The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'.

property ref

ref?: StorageReference | undefined;

• StorageReference associated with this upload.

property size

size: number;

• The size of this object, in bytes.

property timeCreated

timeCreated: string;

• A date string representing when this object was created.

property updated

updated: string;

• A date string representing when this object was last updated.

property maxResults

maxResults?: number | null;

• If set, limits the total number of prefixes and items to return. The default and maximum maxResults is 1000.

property pageToken

pageToken?: string | null;

• The nextPageToken from a previous call to list(). If provided, listing is resumed from the previous position.

property items

items: StorageReference[];

• Objects in this directory. You can call getMetadata() and getDownloadUrl() on them.

property nextPageToken

nextPageToken?: string;

• If set, there might be more results for this list. Use this token to resume the list.

property prefixes

prefixes: StorageReference[];

• References to prefixes (sub-folders). You can call list() on them to get its contents.

  Folders are implicit based on '/' in the object paths. For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a') will return '/a/b' as a prefix.

property cacheControl

cacheControl?: string | undefined;

• Served as the 'Cache-Control' header on object download.

property contentDisposition

contentDisposition?: string | undefined;

• Served as the 'Content-Disposition' header on object download.

property contentEncoding

contentEncoding?: string | undefined;

• Served as the 'Content-Encoding' header on object download.

property contentLanguage

contentLanguage?: string | undefined;

• Served as the 'Content-Language' header on object download.

property contentType

contentType?: string | undefined;

• Served as the 'Content-Type' header on object download.

property customMetadata

customMetadata?:
    | {
          [key: string]: string;
      }
    | undefined;

• Additional user-defined custom metadata.

property complete

complete?: CompleteFn | null;

property error

error?: (error: StorageError) => void | null;

property next

next?: NextFn<T> | null;

property bucket

bucket: string;

• The name of the bucket containing this reference's object.

property fullPath

fullPath: string;

• The full path of this object.

property name

name: string;

• The short name of this object, which is the last component of the full path. For example, if fullPath is 'full/path/image.png', name is 'image.png'.

property parent

parent: StorageReference | null;

• A reference pointing to the parent location of this reference, or null if this reference is the root.

property root

root: StorageReference;

• A reference to the root of this object's bucket.

property storage

storage: FirebaseStorage;

• The FirebaseStorage instance associated with this reference.

method toString

toString: () => string;

• Returns a gs:// URL for this object in the form gs://<bucket>/<path>/<to>/<object>

  Returns

  The gs:// URL.

property md5Hash

md5Hash?: string | undefined;

• A Base64-encoded MD5 hash of the object being uploaded.

property metadata

readonly metadata: FullMetadata;

• Contains the metadata sent back from the server.

property ref

readonly ref: StorageReference;

• The reference that spawned this upload.

property snapshot

snapshot: UploadTaskSnapshot;

• A snapshot of the current task state.

method cancel

cancel: () => boolean;

• Cancels a running task. Has no effect on a complete or failed task.

  Returns

  True if the cancel had an effect.

method catch

catch: (onRejected: (error: StorageError) => unknown) => Promise<unknown>;

• Equivalent to calling then(null, onRejected).

method on

on: (
    event: TaskEvent,
    nextOrObserver?:
        | StorageObserver<UploadTaskSnapshot>
        | ((snapshot: UploadTaskSnapshot) => unknown),
    error?: (a: StorageError) => unknown,
    complete?: Unsubscribe | null
) => Unsubscribe | Subscribe<UploadTaskSnapshot>;

• Listens for events on this task.

  Events have three callback functions (referred to as next, error, and complete).

  If only the event is passed, a function that can be used to register the callbacks is returned. Otherwise, the callbacks are passed after the event.

  Callbacks can be passed either as three separate arguments or as the next, error, and complete properties of an object. Any of the three callbacks is optional, as long as at least one is specified. In addition, when you add your callbacks, you get a function back. You can call this function to unregister the associated callbacks.

  Parameter event

  The type of event to listen for.

  Parameter nextOrObserver

  The next function, which gets called for each item in the event stream, or an observer object with some or all of these three properties (next, error, complete).

  Parameter error

  A function that gets called with a StorageError if the event stream ends due to an error.

  Parameter completed

  A function that gets called if the event stream ends normally.

  Returns

  If only the event argument is passed, returns a function you can use to add callbacks (see the examples above). If more than just the event argument is passed, returns a function you can call to unregister the callbacks.

  Example 1

  **Pass callbacks separately or in an object.**

  var next = function(snapshot) {};
  var error = function(error) {};
  var complete = function() {};
  
  // The first example.
  uploadTask.on(
      firebase.storage.TaskEvent.STATE_CHANGED,
      next,
      error,
      complete);
  
  // This is equivalent to the first example.
  uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
    'next': next,
    'error': error,
    'complete': complete
  });
  
  // This is equivalent to the first example.
  var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
  subscribe(next, error, complete);
  
  // This is equivalent to the first example.
  var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
  subscribe({
    'next': next,
    'error': error,
    'complete': complete
  });

  Example 2

  **Any callback is optional.**

  // Just listening for completion, this is legal.
  uploadTask.on(
      firebase.storage.TaskEvent.STATE_CHANGED,
      null,
      null,
      function() {
        console.log('upload complete!');
      });
  
  // Just listening for progress/state changes, this is legal.
  uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, function(snapshot) {
    var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
    console.log(percent + "% done");
  });
  
  // This is also legal.
  uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
    'complete': function() {
      console.log('upload complete!');
    }
  });

  Example 3

  **Use the returned function to remove callbacks.**

  var unsubscribe = uploadTask.on(
      firebase.storage.TaskEvent.STATE_CHANGED,
      function(snapshot) {
        var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
        console.log(percent + "% done");
        // Stop after receiving one update.
        unsubscribe();
      });
  
  // This code is equivalent to the above.
  var handle = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
  unsubscribe = handle(function(snapshot) {
    var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
    console.log(percent + "% done");
    // Stop after receiving one update.
    unsubscribe();
  });

method pause

pause: () => boolean;

• Pauses a currently running task. Has no effect on a paused or failed task.

  Returns

  True if the operation took effect, false if ignored.

method resume

resume: () => boolean;

• Resumes a paused task. Has no effect on a currently running or failed task.

  Returns

  True if the operation took effect, false if ignored.

method then

then: (
    onFulfilled?: (snapshot: UploadTaskSnapshot) => unknown,
    onRejected?: (error: StorageError) => unknown
) => Promise<unknown>;

• This object behaves like a Promise, and resolves with its snapshot data when the upload completes.

  Parameter onFulfilled

  The fulfillment callback. Promise chaining works as normal.

  Parameter onRejected

  The rejection callback.

property bytesTransferred

bytesTransferred: number;

• The number of bytes that have been successfully uploaded so far.

property metadata

metadata: FullMetadata;

• Before the upload completes, contains the metadata sent to the server. After the upload completes, contains the metadata sent back from the server.

property ref

ref: StorageReference;

• The reference that spawned this snapshot's upload task.

property state

state: TaskState;

• The current state of the task.

property task

task: UploadTask;

• The task of which this is a snapshot.

property totalBytes

totalBytes: number;

• The total number of bytes to be uploaded.

member APP_DELETED

APP_DELETED = 'app-deleted'

member BUCKET_NOT_FOUND

BUCKET_NOT_FOUND = 'bucket-not-found'

member CANCELED

CANCELED = 'canceled'

member CANNOT_SLICE_BLOB

CANNOT_SLICE_BLOB = 'cannot-slice-blob'

member INTERNAL_ERROR

INTERNAL_ERROR = 'internal-error'

member INVALID_ARGUMENT

INVALID_ARGUMENT = 'invalid-argument'

member INVALID_ARGUMENT_COUNT

INVALID_ARGUMENT_COUNT = 'invalid-argument-count'

member INVALID_CHECKSUM

INVALID_CHECKSUM = 'invalid-checksum'

member INVALID_DEFAULT_BUCKET

INVALID_DEFAULT_BUCKET = 'invalid-default-bucket'

member INVALID_EVENT_NAME

INVALID_EVENT_NAME = 'invalid-event-name'

member INVALID_FORMAT

INVALID_FORMAT = 'invalid-format'

member INVALID_ROOT_OPERATION

INVALID_ROOT_OPERATION = 'invalid-root-operation'

member INVALID_URL

INVALID_URL = 'invalid-url'

member NO_DEFAULT_BUCKET

NO_DEFAULT_BUCKET = 'no-default-bucket'

member NO_DOWNLOAD_URL

NO_DOWNLOAD_URL = 'no-download-url'

member OBJECT_NOT_FOUND

OBJECT_NOT_FOUND = 'object-not-found'

member PROJECT_NOT_FOUND

PROJECT_NOT_FOUND = 'project-not-found'

member QUOTA_EXCEEDED

QUOTA_EXCEEDED = 'quota-exceeded'

member RETRY_LIMIT_EXCEEDED

RETRY_LIMIT_EXCEEDED = 'retry-limit-exceeded'

member SERVER_FILE_WRONG_SIZE

SERVER_FILE_WRONG_SIZE = 'server-file-wrong-size'

member UNAUTHENTICATED

UNAUTHENTICATED = 'unauthenticated'

member UNAUTHORIZED

UNAUTHORIZED = 'unauthorized'

member UNAUTHORIZED_APP

UNAUTHORIZED_APP = 'unauthorized-app'

member UNKNOWN

UNKNOWN = 'unknown'

member UNSUPPORTED_ENVIRONMENT

UNSUPPORTED_ENVIRONMENT = 'unsupported-environment'