feat(storage): add useMetadata

README.md

@@ -394,6 +394,24 @@ Returns:
 -   `loading`: `true` while fetching the download URL; `false` if the download URL was fetched successfully or an error occurred
 -   `error`: `undefined` if no error occurred
 
+#### useMetadata
+
+Returns the metadata of a Google Cloud Storage object
+
+```javascript
+const [metadata, loading, error] = useMetadata(storageReference);
+```
+
+Params:
+
+-   `reference`: Reference to a Google Cloud Storage object
+
+Returns:
+
+-   `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
+
 ## Development
 
 ### Build

src/storage/index.ts

@@ -1,2 +1,3 @@
 export * from "./useBytes";
 export * from "./useDownloadURL";
+export * from "./useMetadata";

src/storage/useMetadata.ts

@@ -0,0 +1,19 @@
+import { FullMetadata, getMetadata, StorageError, StorageReference } from "firebase/storage";
+import { ValueHookResult } from "../common";
+import { useOnce } from "../internal/useOnce";
+import { isStorageRefEqual } from "./internal";
+
+export type UseMetadataResult = ValueHookResult<FullMetadata, StorageError>;
+
+/**
+ * Returns the metadata of a Google Cloud Storage object
+ *
+ * @param {StorageReference | undefined | null} reference Reference to a Google Cloud Storage object
+ * @returns {UseMetadataResult} 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 function useMetadata(reference: StorageReference | undefined | null): UseMetadataResult {
+    return useOnce(reference ?? undefined, getMetadata, isStorageRefEqual);
+}