refactor: allow download as stream

Author: xxRockOnxx

src/packages/StorageFileApi.ts

@@ -521,13 +521,14 @@ export default class StorageFileApi {
    *
    * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
    * @param options.transform Transform the asset before serving it to the client.
+   * @param options.stream If set to true, the response will be a ReadableStream. Otherwise, it will be a Blob (default).
    */
-  async download(
+  async download<Options extends { transform?: TransformOptions, stream?: boolean }>(
     path: string,
-    options?: { transform?: TransformOptions }
+    options?: Options
   ): Promise<
     | {
-        data: Blob
+        data: Options['stream'] extends true ? ReadableStream : Blob
         error: null
       }
     | {
@@ -546,8 +547,16 @@ export default class StorageFileApi {
         headers: this.headers,
         noResolveJson: true,
       })
-      const data = await res.blob()
-      return { data, error: null }
+
+      if (!options?.stream) {
+        const data = await res.blob()
+        return { data, error: null }
+      }
+
+      return {
+        data: res.body,
+        error: null,
+      }
     } catch (error) {
       if (this.shouldThrowOnError) {
         throw error

test/storageFileApi.test.ts

@@ -420,6 +420,16 @@ describe('Object API', () => {
       ).rejects.toThrow()
     })
 
+    test('downloads an object as a stream', async () => {
+      await storage.from(bucketName).upload(uploadPath, file)
+      const res = await storage.from(bucketName).download(uploadPath, {
+        stream: true,
+      })
+
+      expect(res.error).toBeNull()
+      expect(res.data).toBeInstanceOf(ReadableStream)
+    })
+
     test('removes an object', async () => {
       await storage.from(bucketName).upload(uploadPath, file)
       const res = await storage.from(bucketName).remove([uploadPath])