Skip to content

fix(types): add missing contentEncoding to S3Options type definition #27329

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

Merged
Jarred-Sumner merged 1 commit into from
Mar 1, 2026
Merged

fix(types): add missing contentEncoding to S3Options type definition #27329

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
19 changes: 19 additions & 0 deletions packages/bun-types/s3.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,25 @@ declare module "bun" {
*/
contentDisposition?: string | undefined;

/**
* The Content-Encoding header value.
* Specifies what content encodings have been applied to the object,
* for example to indicate that it has been compressed.
*
* @example
* // Setting gzip encoding
* const file = s3.file("data.json.gz", {
* contentEncoding: "gzip"
* });
*
* @example
* // Setting encoding when writing
* await s3.write("data.json.gz", compressedData, {
* contentEncoding: "gzip"
* });
*/
contentEncoding?: string | undefined;

/**
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
*
Expand Down