Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(js): support uploadData checksumAlgorithm option #8162

Merged
merged 1 commit into from
Dec 12, 2024
+4 −1
Merged

docs(js): support uploadData checksumAlgorithm option #8162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/pages/[platform]/build-a-backend/storage/upload-files/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1568,9 +1568,11 @@ const result = await uploadData({
// whether to use accelerate endpoint
useAccelerateEndpoint: true,
// the account ID that owns requested bucket
expectedBucketOwner: '123456789012',
expectedBucketOwner: "123456789012",
// whether to check if an object with the same key already exists before completing the upload
preventOverwrite: true,
// whether to compute the checksum for the data to be uploaded, so the S3 can verify the data integrity
checksumAlgorithm: "crc-32", // only 'crc-32' is supported currently
},
});
```
Expand All @@ -1584,6 +1586,7 @@ Option | Type | Default | Description |
| useAccelerateEndpoint | boolean | false | Whether to use accelerate endpoint. <br/><br/> Read more at [Transfer Acceleration](/[platform]/build-a-backend/storage/upload-files/#transfer-acceleration) |
| expectedBucketOwner | string | - | The account ID that owns requested bucket. |
| preventOverwrite | boolean | false | Whether to check if an object with the same key already exists before completing the upload. If exists, a `Precondition Failed` error will be thrown |
| checksumAlgorithm | "crc-32" | - | Whether to compute the checksum for the data to be uploaded, so the S3 can verify the data integrity. Only 'crc-32' is supported currently |

<Callout>

Expand Down
Loading