Callable

  • storage(app?: App): Storage
  • Gets the Storage service for the default app or a given app.

    firebase.storage() can be called with no arguments to access the default app's Storage service or as firebase.storage(app) to access the Storage service associated with a specific app.

    example
    // Get the Storage service for the default app
    var defaultStorage = firebase.storage();
    example
    // Get the Storage service for a given app
    var otherStorage = firebase.storage(otherApp);

    Parameters

    • Optional app: App

      The app to create a storage service for. If not passed, uses the default app.

    Returns Storage

Index

Type aliases

StringFormat

StringFormat: string
enum

{string} An enumeration of the possible string formats for upload.

TaskEvent

TaskEvent: string

An event that is triggered on a task.

enum

{string}

see

{@link firebase.storage.UploadTask.prototype.on}

TaskState

TaskState: string

Represents the current state of a running upload.

enum

{string}

Variables

StringFormat

StringFormat: object

Type declaration

  • BASE64: StringFormat

    Indicates the string should be interpreted as base64-encoded data. Padding characters (trailing '='s) are optional. Example: The string 'rWmO++E6t7/rlw==' becomes the byte sequence ad 69 8e fb e1 3a b7 bf eb 97

  • BASE64URL: StringFormat

    Indicates the string should be interpreted as base64url-encoded data. Padding characters (trailing '='s) are optional. Example: The string 'rWmO--E6t7_rlw==' becomes the byte sequence ad 69 8e fb e1 3a b7 bf eb 97

  • DATA_URL: StringFormat

    Indicates the string is a data URL, such as one obtained from canvas.toDataURL(). Example: the string 'data:application/octet-stream;base64,aaaa' becomes the byte sequence 69 a6 9a (the content-type "application/octet-stream" is also applied, but can be overridden in the metadata object).

  • RAW: StringFormat

    Indicates the string should be interpreted "raw", that is, as normal text. The string will be interpreted as UTF-16, then uploaded as a UTF-8 byte sequence. Example: The string 'Hello! \ud83d\ude0a' becomes the byte sequence 48 65 6c 6c 6f 21 20 f0 9f 98 8a

TaskEvent

TaskEvent: object

Type declaration

  • STATE_CHANGED: TaskEvent

    For this event,

    • The `next` function is triggered on progress updates and when the task is paused/resumed with a firebase.storage.UploadTaskSnapshot as the first argument.
    • The `error` function is triggered if the upload is canceled or fails for another reason.
    • The `complete` function is triggered if the upload completes successfully.

TaskState

TaskState: object

Type declaration