Skip to content

Latest commit

 

History

History
154 lines (92 loc) · 4.62 KB

_storage_.md

File metadata and controls

154 lines (92 loc) · 4.62 KB
Raw

reactfire

Globals / "storage"

Module: "storage"

Index

Type aliases

Functions

Type aliases

StorageImageProps

Ƭ StorageImageProps: { placeHolder?: JSX.Element ; storage?: firebase.storage.Storage ; storagePath: string ; suspense?: undefined | false | true }

Defined in src/storage.tsx:60

Type declaration:

Name Type
placeHolder? JSX.Element
storage? firebase.storage.Storage
storagePath string
suspense? undefined | false | true

Functions

INTERNALStorageImage

▸ INTERNALStorageImage(props: StorageImageProps & React.DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): Element

Defined in src/storage.tsx:75

Parameters:

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

Returns: Element

StorageFromContext

▸ StorageFromContext(props: StorageImageProps & React.DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): Element

Defined in src/storage.tsx:67

Parameters:

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

Returns: Element

StorageImage

▸ StorageImage(props: StorageImageProps & React.DetailedHTMLProps<ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>): Element

Defined in src/storage.tsx:102

Parameters:

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

Returns: Element

_fromTask

▸ _fromTask(task: UploadTask): Observable<UploadTaskSnapshot>

Defined in src/storage.tsx:13

modified version of rxFire's _fromTask

Parameters:

Name Type Description
task UploadTask

Returns: Observable<UploadTaskSnapshot>

useStorageDownloadURL

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

Defined in src/storage.tsx:53

Subscribe to a storage ref's download URL

Type parameters:

Name Default
T string

Parameters:

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

Returns: ObservableStatus<string | T>

useStorageTask

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

Defined in src/storage.tsx:36

Subscribe to the progress of a storage task

Type parameters:

Name Default
T unknown

Parameters:

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

Returns: ObservableStatus<UploadTaskSnapshot | T>