UNPKG

react-firehooks

Version:

Lightweight dependency-free collection of React hooks for Firebase

16 lines (15 loc) 926 B
import { StorageError, StorageReference } from "firebase/storage"; import { ValueHookResult } from "../common/index.js"; export type UseBlobResult = ValueHookResult<Blob, StorageError>; /** * Returns the data of a Google Cloud Storage object as a Blob * * This hook is not available in Node * @param reference Reference to a Google Cloud Storage object * @param maxDownloadSizeBytes If set, the maximum allowed size in bytes to retrieve * @returns Data, loading state, and error * - value: Object data as a Blob; `undefined` if data of the object is currently being downloaded, or an error occurred * - loading: `true` while downloading the data of the object; `false` if the data was downloaded successfully or an error occurred * - error: `undefined` if no error occurred */ export declare function useBlob(reference: StorageReference | undefined | null, maxDownloadSizeBytes?: number | undefined): UseBlobResult;