Skip to content

Latest commit

 

History

History
90 lines (53 loc) · 2.21 KB

storage.md

File metadata and controls

90 lines (53 loc) · 2.21 KB

ReactFire reference docs / storage

Module: storage

Table of contents

Functions

Functions

StorageImage

▸ StorageImage(props): Element

Parameters

Name Type
props StorageImageProps & React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>

Returns

Element

Defined in

src/storage.tsx:78

useStorageDownloadURL

▸ useStorageDownloadURL<T>(ref, options?): ObservableStatus<string | T>

Subscribe to a storage ref's download URL

Type parameters

Name Type
T string

Parameters

Name Type Description
ref StorageReference reference to the blob you want to download
options? ReactFireOptions<T>

Returns

ObservableStatus<string | T>

Defined in

src/storage.tsx:29

useStorageTask

▸ useStorageTask<T>(task, ref, options?): ObservableStatus<UploadTaskSnapshot | T>

Subscribe to the progress of a storage task

Type parameters

Name Type
T unknown

Parameters

Name Type Description
task UploadTask the task you want to listen to
ref StorageReference reference to the blob the task is acting on
options? ReactFireOptions<T>

Returns

ObservableStatus<UploadTaskSnapshot | T>

Defined in

src/storage.tsx:16