[ Web Proxy ]
URL:
Viewing: https://firebase.google.com/docs/reference/node/firebase.storage [Back]  [Original]

storage | JavaScript SDK  |  Node.js (client) API reference  |  Firebase Skip to main content
Overview Fundamentals AI Build Run Reference Samples
Firebase [Firebase]
Send feedback Stay organized with collections Save and categorize content based on your preferences.

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

TaskEvent

TaskEvent: string

An event that is triggered on a task.

see

firebase.storage.UploadTask.on

TaskState

TaskState: string

Represents the current state of a running upload.

Variables

StringFormat

StringFormat: { BASE64: StringFormat; BASE64URL: StringFormat; DATA_URL: StringFormat; RAW: StringFormat }

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: { STATE_CHANGED: TaskEvent }

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: { CANCELED: TaskState; ERROR: TaskState; PAUSED: TaskState; RUNNING: TaskState; SUCCESS: TaskState }

Type declaration

Send feedback

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2023-05-23 UTC.

Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-05-23 UTC."],[],[]]

Web Proxy Viewer  |  New URL  |  Original Page