Dart Reference v2.0

Download a file

Downloads a file.

Policy permissions required:
- buckets permissions: none
- objects permissions: select
Refer to the Storage guide on how access control works

Parameters

path

REQUIRED

String

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

transform

Optional

TransformOptions

Transform the asset before serving it to the client.

width

Optional

int

The width of the image in pixels.

height

Optional

int

The height of the image in pixels.

resize

Optional

ResizeMode

Specifies how image cropping should be handled when performing image transformations. Defaults to `ResizeMode.cover`.

quality

Optional

int

Set the quality of the returned image. A number from 20 to 100, with 100 being the highest quality. Defaults to 80

format

Optional

RequestImageFormat

Specify the format of the image requested. When using 'origin' we force the format to be the same as the original image. When this option is not passed in, images are optimized to modern image formats like Webp.


final Uint8List file = await supabase
  .storage
  .from('avatars')
  .download('avatar1.png');

Response