JavaScript: download

Downloads a file from a private bucket. For public buckets, make a request to the URL returned from getPublicUrl instead.

Parameters

• path

  (Required)

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

• options

  (Optional)

• parameters

  (Optional)

  Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control.

Examples

Download file

const { data, error } = await supabase
  .storage
  .from('avatars')
  .download('folder/avatar1.png')

Download file with transformations

const { data, error } = await supabase
  .storage
  .from('avatars')
  .download('folder/avatar1.png', {
    transform: {
      width: 100,
      height: 100,
      quality: 80
    }
  })

Download with cache control (useful in Edge Functions)

const { data, error } = await supabase
  .storage
  .from('avatars')
  .download('folder/avatar1.png', {}, { cache: 'no-store' })

Download with abort signal

const controller = new AbortController()
setTimeout(() => controller.abort(), 5000)

const { data, error } = await supabase
  .storage
  .from('avatars')
  .download('folder/avatar1.png', {}, { signal: controller.signal })