React Native Firebase
    Preparing search index...

    Module @react-native-firebase/storage

    Functions

    connectStorageEmulator

    Modify this Storage instance to communicate with the Firebase Storage emulator.

    deleteObject

    Deletes the object at this reference's location.

    getBlob

    Downloads the data at the object's location. Returns an error if the object is not found.

    getBytes

    Downloads the data at the object's location. Returns an error if the object is not found.

    getDownloadURL

    Deletes the object at this reference's location.

    getMetadata

    Fetches metadata for the object at this location, if one exists.

    getStorage

    Returns a Storage instance for the given app.

    getStream

    Downloads the data at the object's location. This API is only available in Nodejs.

    list

    List items (files) and prefixes (folders) under this storage reference

    listAll

    List all items (files) and prefixes (folders) under this storage reference.

    putFile

    Puts a file from local disk onto the storage bucket.

    ref

    Returns a StorageReference for the given URL or path in the default bucket.

    setMaxDownloadRetryTime

    Sets the maximum time in milliseconds to retry a download if a failure occurs.

    setMaxOperationRetryTime

    Sets the maximum time in milliseconds to retry a download if a failure occurs.. android & iOS only.

    setMaxUploadRetryTime

    Sets the maximum time in milliseconds to retry an upload if a failure occurs. android & iOS only.

    updateMetadata

    Updates the metadata for this object.

    uploadBytes

    Uploads data to this object's location. The upload is not resumable.

    uploadBytesResumable

    Uploads data to this object's location. The upload is not resumable.

    uploadString

    Uploads data to this object's location. The upload is not resumable.

    writeToFile

    Downloads a file to the specified local file path on the device.

    Interfaces

    EmulatorMockTokenOptions

    Options for connecting to the storage emulator (web only).

    FirebaseStorage

    Storage module instance

    FullMetadata

    The full set of object metadata, including read-only properties.

    ListOptions

    Options for listing files and folders.

    ListResult

    Result of listing files and folders.

    SettableMetadata

    Object metadata that can be set at any time.

    StorageObserver

    A stream observer for Firebase Storage.

    StorageReference

    Storage reference to a file or folder location.

    TaskSnapshot

    Snapshot of a storage task (upload or download).

    UploadMetadata

    Object metadata that can be set at upload.

    UploadResult

    Result returned from a non-resumable upload.

    UploadTask

    Represents the process of uploading an object. Allows you to monitor and manage the upload.

    UploadTaskSnapshot

    Holds data about the current state of the upload task.

    Namespaces

    FirebaseStorageTypes

    Type Aliases

    CompleteFn
    NativeFirebaseError
    NextFn
    StringFormat

    An enumeration of the possible string formats for upload.

    Subscribe
    Task

    Storage task for uploads or downloads.

    TaskEvent

    An event that is triggered on a task.

    TaskResult

    Result of a completed task.

    TaskSnapshotObserver

    Observer object for task state changes.

    TaskState

    Represents the current state of a running upload/download.

    Unsubscribe

    A function that unsubscribes from an event listener.

    Variables

    default
    firebase
    SDK_VERSION
    StringFormat

    An enumeration of the possible string formats for upload.

    TaskEvent

    An event that is triggered on a task.

    TaskState

    Represents the current state of a running upload/download.