react-firehooks/lib/storage/useMetadata.d.ts

Lightweight dependency-free collection of React hooks for Firebase

import { FullMetadata, StorageError, StorageReference } from "firebase/storage";
import type { ValueHookResult } from "../common/index.js";
export type UseMetadataResult = ValueHookResult<FullMetadata, StorageError>;
/**
 * Returns the metadata of a Google Cloud Storage object
 * @param reference Reference to a Google Cloud Storage object
 * @returns Metadata, loading state, and error
 * - value: Metadata; `undefined` if metadata is currently being fetched, or an error occurred
 * - loading: `true` while fetching the metadata; `false` if the metadata was fetched successfully or an error occurred
 * - error: `undefined` if no error occurred
 */
export declare function useMetadata(reference: StorageReference | undefined | null): UseMetadataResult;