fix: update docs for public url (#141)

inian · web-flow · commit 307644ad17d5 · 2023-01-13T19:44:56.000+08:00
diff --git a/src/packages/StorageFileApi.ts b/src/packages/StorageFileApi.ts
@@ -397,7 +397,7 @@ export default class StorageFileApi {
   }
 
   /**
-   * Retrieves the URL for an asset in a public bucket.
+   * A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.
    * This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.
    *
    * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.

Original file line number	Diff line number	Diff line change
`@@ -397,7 +397,7 @@ export default class StorageFileApi {`
`397`	`397`	`}`
`398`	`398`
`399`	`399`	`/**`
`400`		`- * Retrieves the URL for an asset in a public bucket.`
	`400`	`+ * A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.`
`401`	`401`	`* This function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset.`
`402`	`402`	`*`
`403`	`403`	* @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.