Skip to content

Commit 336e498

Browse files
authored
docs(storage): clarify upsert has no effect in uploadToSignedUrl (#1915)
1 parent 2596a09 commit 336e498

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

packages/core/storage-js/src/packages/StorageFileApi.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,9 @@ export default class StorageFileApi {
236236
* @param path The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload.
237237
* @param token The token generated from `createSignedUploadUrl`
238238
* @param fileBody The body of the file to be stored in the bucket.
239-
* @param fileOptions Optional file upload options including cacheControl and contentType.
239+
* @param fileOptions HTTP headers (cacheControl, contentType, etc.).
240+
* **Note:** The `upsert` option has no effect here. To enable upsert behavior,
241+
* pass `{ upsert: true }` when calling `createSignedUploadUrl()` instead.
240242
* @returns Promise with response containing file path and fullPath or error
241243
*
242244
* @example Upload to a signed URL

0 commit comments

Comments
 (0)