chore: update docs for download method (#139)

inian · web-flow · commit dd358368c24d · 2023-01-11T11:54:32.000+08:00
diff --git a/src/packages/StorageFileApi.ts b/src/packages/StorageFileApi.ts
@@ -356,7 +356,7 @@ export default class StorageFileApi {
   }
 
   /**
-   * Downloads a file.
+   * Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead.
    *
    * @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.

Original file line number	Diff line number	Diff line change
`@@ -356,7 +356,7 @@ export default class StorageFileApi {`
`356`	`356`	`}`
`357`	`357`
`358`	`358`	`/**`
`359`		`- * Downloads a file.`
	`359`	+ * Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead.
`360`	`360`	`*`
`361`	`361`	* @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
`362`	`362`	`* @param options.transform Transform the asset before serving it to the client.`