Flutter: downloadStream

Downloads a file as a lazy Stream<Uint8List>, streaming the bytes instead of buffering the whole file into memory like download().

• The request is sent when the stream is listened to. A non-success response surfaces as a StorageException on the stream before any bytes are emitted.
• Prefer this over download() for large files to keep memory usage low.
• Policy permissions required:
  • buckets permissions: none
  • objects permissions: select
• Refer to the Storage guide on how access control works

Parameters

• path

  (Required)

  The full path and file name of the file to be downloaded. For example folder/image.png.

• cacheNonce

  (Optional)

  Adds a `cacheNonce` query parameter to bypass CDN caching for a specific file version.

• transform

  (Optional)

  Transform the asset before serving it to the client.

Examples

Download a file as a stream

final Stream<Uint8List> stream = supabase
  .storage
  .from('avatars')
  .downloadStream('avatar1.png');

await for (final chunk in stream) {
  // Handle each chunk of bytes as it arrives
}