feat(storage): add downloadStream for streaming file downloads#1580
Merged
Conversation
Adds an optional cacheNonce parameter to getPublicUrl, createSignedUrl, createSignedUrls and download, appending a cacheNonce query parameter to the generated URL to bypass CDN caching for a specific file version. Ref: SDK-875
github-actions
Bot
added
the
storage
Adds StorageFileApi.listPaginated, backed by the storage list-v2 endpoint, supporting cursor-based pagination and hierarchical (delimiter) listing via PaginatedSearchOptions and returning a PaginatedListResult of PaginatedFile and PaginatedFolder entries. Implements storage.file_buckets.list_files_paginated.
spydon
force-pushed
the
lukasklingsbo/storage-list-v2
branch
from
dc28e71 to
5653c6a
Compare
spydon
force-pushed
the
lukasklingsbo/storage-download-stream
branch
from
aa3d02e to
5bc78e5
Compare
Adds StorageFileApi.downloadStream, returning the response body as a Stream<List<int>> for memory-efficient handling of large files instead of buffering into a Uint8List. A non-success response throws a StorageException before the stream is returned. Implements storage.file_buckets.download_as_stream.
spydon
force-pushed
the
lukasklingsbo/storage-download-stream
branch
from
5bc78e5 to
1b049ee
Compare
grdsdev
approved these changes
Jul 10, 2026
Vinzent03
approved these changes
Jul 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
StorageFileApi.downloadStream, which returns the response body as a lazyStream<Uint8List>for memory-efficient handling of large files instead of buffering the whole body into aUint8List(asdownloaddoes). The request is sent when the stream is listened to, and a non-success status surfaces as aStorageExceptionon the stream before any bytes are emitted, matching howFile.openReadbehaves.downloadStream(path, {transform, queryParams, cacheNonce})returnsStream<Uint8List>Fetch.getStreamstreaming GET, anasync*generator marked@internaldownloadanddownloadStreamshare a new private_downloadUribuilder (DRY)Outcome: implemented
Reference: supabase-js
download(...).asStream()(StreamDownloadBuilder)Compliance matrix:
storage.file_buckets.download_as_stream-> implementedNotes
Stream<Uint8List>(notFuture<Stream<List<int>>>and not a chainedasStream()builder), with errors delivered on the stream.Uint8Listis used for the byte chunks, consistent withdownload; becauseStreamis covariant it is still usable anywhere aStream<List<int>>is expected.Stacking
Third of three stacked PRs. Base: #1579 (listPaginated). Review and merge #1578 then #1579 first.