@forge/bridge

5.15.2-next.0-experimental-5b726e65.16.0-next.1
out/object-store/getMetadata.js
~out/object-store/getMetadata.jsModified
+8
Index: package/out/object-store/getMetadata.js
===================================================================
--- package/out/object-store/getMetadata.js
+++ package/out/object-store/getMetadata.js
@@ -5,8 +5,16 @@
 const errors_1 = require("../errors");
 const utils_1 = require("./utils");
 const bridge_1 = require("../bridge");
 const callBridge = (0, bridge_1.getCallBridge)();
+/**
+ * Get metadata for multiple objectIds
+ *
+ * @param functionKey - Configuration object containing the backend function key to filter and generate object metadata
+ * @param keys - Array of object keys to get metadata for
+ * @returns Promise resolving to GetMetadataResult[]
+ * @throws {BridgeAPIError} When filtering fails or download encounters an error
+ */
 const getMetadata = async ({ functionKey, keys }) => {
     await (0, utils_1.checkRestrictedEnvironment)();
     void callBridge('trackObjectStoreAction', { action: 'getMetadata' });
     if (!functionKey || functionKey.length === 0) {