Meta tags:
description=Bun provides fast, native bindings for interacting with S3-compatible object storage services.;

Headings (most frequently used words):

s3client, s3, bun, with, static, using, files, prototype, urls, s3file, system, storage, working, from, write, delete, exists, utf, documentation, index, on, this, page, basic, usage, presigning, support, for, compatible, services, credentials, error, codes, methods, protocol, get, started, core, runtime, file, module, http, server, networking, data, concurrency, process, interop, tooling, utilities, standards, compatibility, contributing, api, is, fast, reading, writing, uploading, to, large, streams, setting, acls, expiring, method, new, response, aws, google, cloud, cloudflare, r2, digitalocean, spaces, minio, supabase, virtual, hosted, style, endpoints, objects, partial, reads, slice, deleting, presign, list, size, stat, 16, and, bom, byte, order, mark, memory, optimization,

Text of the page (most frequently used words):
the (118), #s3client (115), bun (90), file (81), const (62), bucket (61), await (53), #endpoint (51), s3file (50), write (48), key (45), with (44), credentials (38), your (36), from (34), https (32), com (31), and (28), for (28), new (28), method (28), access (25), txt (25), secretaccesskey (24), accesskeyid (24), static (24), delete (23), json (22), secret (22), use (21), presign (21), url (21), response (20), that (20), using (20), files (19), import (19), exists (19), storage (19), you (18), read (18), client (18), east (16), account (16), utf (14), data (14), amazonaws (14), cloudflare (14), object (14), region (14), text (13), list (13), set (13), string (12), bytes (12), type (12), hello (12), world (12), aws (12), this (11), pass (11), cloudflarestorage (11), public (11), promise (11), environment (11), writer (11), when (10), same (10), blob (10), fetch (10), options (10), equivalent (10), size (10), expiresin (10), acl (10), partial (9), arraybuffer (9), option (9), supabase (9), 1024 (8), uploads (8), presigned (8), methods (8), name (8), api (8), slice (8), upload (8), minio (8), compatible (8), not (7), like (7), also (7), works (7), stat (7), true (7), owner (7), 3600 (7), error (7), instance (7), http (7), prototype (7), reads (7), s3options (7), reference (7), spaces (7), services (7), memory (7), readable (7), bom (6), calling (6), can (6), local (6), unlink (6), get (6), metadata (6), objects (6), application (6), apis (6), stream (6), variables (6), constructor (6), digitalocean (6), content (6), page (5), default (5), range (5), are (5), available (5), all (5), request (5), network (5), any (5), time (5), call (5), server (5), urls (5), documentation (4), hosted (4), javascriptcore (4), protocol (4), check (4), without (4), instances (4), prefix (4), service (4), returns (4), only (4), uint8array (4), instead (4), lazy (4), don (4), localhost (4), sessiontoken (4), variable (4), virtualhostedstyle (4), production (4), google (4), cloud (4), log (4), user (4), put (4), avoid (4), pdf (4), buffer (4), large (4), working (4), filesystem (4), fast (4), byte (3), order (3), mark (3), one (3), code (3), headers (3), support (3), other (3), 500 (3), more (3), html (3), stringify (3), directly (3), path (3), provides (3), interacting (3), following (3), work (3), readablestream (3), extends (3), void (3), number (3), end (3), requests (3), synchronous (3), 9000 (3), explicitly (3), env (3), process (3), used (3), specify (3), virtual (3), style (3), console (3), users (3), control (3), hour (3), writable (3), acls (3), usage (3), filename (3), report (3), download (3), expires (3), hours (3), presigning (3), streams (3), replacing (3), writing (3), duplicating (3), system (3), runtime (3), next (2), redis (2), sqlite (2), detects (2), strips (2), invalid (2), before (2), supports (2), transcoding (2), encoding (2), etag (2), downloading (2), fetchowner (2), maxkeys (2), under (2), each (2), generate (2), res (2), s3error (2), codes (2), deleting (2), means (2), web (2), accept (2), boolean (2), day (2), buckets (2), create (2), these (2), defaults (2), different (2), back (2), endpoints (2), includes (2), dashboard (2), digitaloceanspaces (2), googleapis (2), false (2), expiring (2), delivery (2), authenticated (2), setting (2), myfile (2), attachment (2), contentdisposition (2), disposition (2), specific (2), generates (2), them (2), needs (2), let (2), often (2), bigfile (2), retry (2), automatically (2), streaming (2), age (2), john (2), uploading (2), optimization (2), chunk (2), reading (2), 123 (2), basic (2), native (2), bindings (2), copy (2), contributing (2), node (2), compatibility (2), toml (2), cookies (2), install (2), module (2), typescript (2), search (2), index (2), built, mintlify, developer, platform, powered, youtube, discord, github, previous, raise, issue, suggest, edits, yes, was, helpful, supported, replaces, codepoints, unicode, replacement, character, passing, ufffd, treats, natively, skips, step, consequence, surrogate, pairs, through, source, assumes, 1023, alias, plain, charset, lastmodified, 2025, 07t00, 000z, 7a30b741503c0b461cc14157e2df4ad8, contents, startafter, moreuploads, batch, istruncated, results, field, null, allobjects, 1000, some, 000, bin, example, class, several, itself, err_s3_invalid_session_token, err_s3_invalid_signature, err_s3_invalid_endpoint, err_s3_invalid_path, err_s3_invalid_method, err_s3_missing_credentials, throws, has, property, values, internally, uses, header, want, output, see, lines, omitted, brevity, nan, deprecated, synchronously, because, requires, s3stat, blobpropertybag, start, interface, they, refer, something, necessarily, creation, why, involve, fully, multiple, override, once, initialization, aws_session_token, aws_bucket, aws_endpoint, aws_region, aws_secret_access_key, aws_access_key_id, fallback, falls, matching, aws_, s3_, s3_session_token, s3_bucket, s3_endpoint, s3_region, s3_secret_access_key, s3_access_key_id, r2withendpoint, s3withendpoint, inferred, determines, provided, specified, provide, need, west, turn, shown, section, enable, connection, via, project, settings, might, make, sure, correct, running, nyc3, gcs, implementation, appropriate, bodyused, redirected, location, statustext, status, 302, redirects, saving, bandwidth, cost, sending, redirect, body, post, head, seconds, expiration, full, made, exec, private, explanation, presignedfile, unless, already, have, but, doing, quarterly, downloadurl, force, sets, signature, lets, exposing, granting, unnecessary, reliable, acting, intermediary, flush, partsize, chunks, queuesize, queue, errors, times, 10mb, alloc, handles, multipart, pdfdata, gzip, contentencoding, compresseddata, pre, compressed, way, happens, ascii, transfers, engine, possible, first, makes, until, global, singleton, relying, backblaze, internet, facto, standard, needed, its, resembles, servers, historically, development, things, license, bindgen, building, windows, benchmarking, roadmap, globals, standards, utils, color, semver, glob, hashing, image, htmlrewriter, jsonl, json5, markdown, yaml, secrets, csrf, protection, utilities, transpiler, compiler, ffi, interop, tooling, cron, webview, spawn, shell, workers, concurrency, sql, archive, binary, dns, udp, tcp, websockets, networking, metrics, handling, tls, routing, router, plugins, auto, jsx, resolution, types, bunfig, repl, debugging, watch, mode, core, init, quickstart, installation, welcome, started, feedback, blog, guides, test, runner, bundler, package, manager, navigation, home, skip, main, discover, pages, exploring, further, complete, docs, llms,

Text of the page (random words):
s to s3 writing to s3 works the same way s3 ts write a string replacing the file await s3file write hello world write a buffer replacing the file await s3file write buffer from hello world write a response replacing the file await s3file write new response hello world write with content type await s3file write json stringify name john age 30 type application json write with content encoding e g for pre compressed data await s3file write compresseddata type application json contentencoding gzip write with content disposition await s3file write pdfdata type application pdf contentdisposition attachment filename report pdf write using a writer streaming const writer s3file writer type application json writer write hello writer write world await writer end write using bun write await bun write s3file hello world working with large files streams bun automatically handles multipart uploads for large files and supports streaming the same api that works for local files also works for s3 files s3 ts write a large file const bigfile buffer alloc 10 1024 1024 10mb const writer s3file writer automatically retry on network errors up to 3 times retry 3 queue up to 10 requests at a time queuesize 10 upload in 5 mb chunks partsize 5 1024 1024 for let i 0 i 10 i writer write bigfile await writer flush await writer end presigning urls when your production service needs to let users upload files to your server it s often more reliable for the user to upload directly to s3 instead of your server acting as an intermediary to do this presign urls for s3 files presigning generates a url with a signature that lets a user upload that specific file to s3 without exposing your credentials or granting them unnecessary access to your bucket by default bun generates a get url that expires in 24 hours s3 ts import s3 from bun generate a presigned url that expires in 24 hours default const download s3 presign my file txt get expires in 24 hours const upload s3 presign my file expiresin 3600 1 hour method put type application json sets response content type in the presigned url presign with content disposition e g force download with a specific filename const downloadurl s3 presign report pdf expiresin 3600 contentdisposition attachment filename quarterly report pdf you can call presign if on a file reference but avoid doing so unless you already have a reference to avoid memory usage const myfile s3 file my file txt const presignedfile myfile presign expiresin 3600 1 hour setting acls to set an acl access control list on a presigned url pass the acl option s3 ts const url s3file presign acl public read expiresin 3600 you can pass any of the following acls acl explanation public read the object is readable by the public private the object is readable only by the bucket owner public read write the object is readable and writable by the public authenticated read the object is readable by the bucket owner and authenticated users aws exec read the object is readable by the aws account that made the request bucket owner read the object is readable by the bucket owner bucket owner full control the object is readable and writable by the bucket owner log delivery write the object is writable by aws services used for log delivery expiring urls to set an expiration time for a presigned url pass the expiresin option s3 ts const url s3file presign seconds expiresin 3600 1 hour access control list acl public read http method method put method to set the http method for a presigned url pass the method option s3 ts const url s3file presign method put method delete method get method head method post method put new response s3file to redirect users to a presigned url for an s3 file pass an s3file instance to a response object as the body the response redirects the user to a presigned url for the s3 file saving you the memory time and bandwidth cost of downloading the file to your server and sending it back to the user s3 ts const response new response s3file console log response response 0 kb ok false url status 302 statustext headers headers location https account id r2 cloudflarestorage com redirected true bodyused false support for s3 compatible services bun s s3 implementation works with any s3 compatible storage service specify the appropriate endpoint using bun s s3client with aws s3 aws s3 is the default with aws s3 you can pass a region option instead of an endpoint option s3 ts import s3client from bun aws s3 const s3 new s3client accesskeyid access key secretaccesskey secret key bucket my bucket endpoint https s3 us east 1 amazonaws com region us east 1 using bun s s3client with google cloud storage to use bun s s3 client with google cloud storage set endpoint to https storage googleapis com in the s3client constructor s3 ts import s3client from bun google cloud storage const gcs new s3client accesskeyid access key secretaccesskey secret key bucket my bucket endpoint https storage googleapis com using bun s s3client with cloudflare r2 to use bun s s3 client with cloudflare r2 set endpoint to the r2 endpoint in the s3client constructor the r2 endpoint includes your account id s3 ts import s3client from bun cloudflare r2 const r2 new s3client accesskeyid access key secretaccesskey secret key bucket my bucket endpoint https account id r2 cloudflarestorage com using bun s s3client with digitalocean spaces to use bun s s3 client with digitalocean spaces set endpoint to the digitalocean spaces endpoint in the s3client constructor s3 ts import s3client from bun const spaces new s3client accesskeyid access key secretaccesskey secret key bucket my bucket region nyc3 endpoint https region digitaloceanspaces com using bun s s3client with minio to use bun s s3 client with minio set endpoint to the url that minio is running on in the s3client constructor s3 ts import s3client from bun const minio new s3client accesskeyid access key secretaccesskey secret key bucket my bucket make sure to use the correct endpoint url it might not be localhost in production endpoint http localhost 9000 using bun s s3client with supabase to use bun s s3 client with supabase set endpoint to the supabase endpoint in the s3client constructor the supabase endpoint includes your account id and the storage v1 s3 path in the supabase dashboard at https supabase com dashboard project account id settings storage turn on enable connection via s3 protocol and use the region shown in that section s3 ts import s3client from bun const supabase new s3client accesskeyid access key secretaccesskey secret key bucket my bucket region us west 1 endpoint https account id supabase co storage v1 s3 storage using bun s s3client with s3 virtual hosted style endpoints when using a virtual hosted style endpoint set the virtualhostedstyle option to true if you don t specify an endpoint bun determines the aws s3 endpoint from the provided region and bucket if no region is specified bun defaults to us east 1 if you explicitly provide an endpoint you don t need to specify a bucket name s3 ts import s3client from bun aws s3 endpoint inferred from region and bucket const s3 new s3client accesskeyid access key secretaccesskey secret key bucket my bucket virtualhostedstyle true endpoint https my bucket s3 us east 1 amazonaws com region us east 1 aws s3 const s3withendpoint new s3client accesskeyid access key secretaccesskey secret key endpoint https bucket name s3 region amazonaws com virtualhostedstyle true cloudflare r2 const r2withendpoint new s3client accesskeyid access key secretaccesskey secret key endpoint https bucket name account id r2 cloudflarestorage com virtualhostedstyle true credentials by default bun reads the following environment variables for credentials option name environment variable accesskeyid s3_access_key_id secretaccesskey s3_secret_access_key region s3_region endpoint s3_endpoint bucket s3_bucket sessiontoken s3_session_token for each option if the s3_ environment variable is not set bun falls back to the matching aws_ environment variable option name fallback environment variable accesskeyid aws_access_key_id secretaccesskey aws_secret_access_key region aws_region endpoint aws_endpoint bucket aws_bucket sessiontoken aws_session_token bun reads these environment variables from env files or from the process environment at initialization time process env is not used for this options you pass to s3 file credentials new bun s3client credentials or any of the methods that accept credentials override these defaults so if you use the same credentials for different buckets you can set the credentials once in your env file and pass only bucket my bucket to s3 file s3client objects when you re not using environment variables or you re using multiple buckets create an s3client object to set credentials explicitly s3 ts import s3client from bun const client new s3client accesskeyid your access key secretaccesskey your secret key bucket my bucket sessiontoken endpoint https s3 us east 1 amazonaws com endpoint https account id r2 cloudflarestorage com cloudflare r2 endpoint http localhost 9000 minio write using a response await file write new response hello world presign a url const url file presign expiresin 60 60 24 1 day acl public read delete the file await file delete s3client prototype write to upload or write a file to s3 call write on the s3client instance s3 ts const client new bun s3client accesskeyid your access key secretaccesskey your secret key endpoint https s3 us east 1 amazonaws com bucket my bucket await client write my file txt hello world await client write my file txt new response hello world equivalent to await client file my file txt write hello world s3client prototype delete to delete a file from s3 call delete on the s3client instance s3 ts const client new bun s3client accesskeyid your access key secretaccesskey your secret key bucket my bucket await client delete my file txt equivalent to await client file my file txt delete s3client prototype exists to check if a file exists in s3 call exists on the s3client instance s3 ts const client new bun s3client accesskeyid your access key secretaccesskey your secret key bucket my bucket const exists await client exists my file txt equivalent to const exists await client file my file txt exists s3file calling file on an s3client instance or s3 file returns an s3file like bun file s3file instances are lazy they don t refer to something that necessarily exists at the time of creation that s why all the methods that don t involve network requests are fully synchronous type reference interface s3file extends blob slice start number end number s3file exists promise boolean unlink promise void presign options s3options string text promise string json promise any bytes promise uint8array arraybuffer promise arraybuffer stream options s3options readablestream write data string uint8array arraybuffer blob readablestream response request options blobpropertybag promise number exists options s3options promise boolean unlink options s3options promise void delete options s3options promise void presign options s3options string stat options s3options promise s3stat size is not synchronously available because it requires a network request deprecated use stat instead size nan more omitted for brevity see all 30 lines like bun file s3file extends blob so all the methods available on blob are also available on s3file the same api that reads data from a local file also reads data from s3 method output await s3file text string await s3file bytes uint8array await s3file json json await s3file stream readablestream await s3file arraybuffer arraybuffer that means s3file instances work with fetch response and other web apis that accept blob instances partial reads with slice to read a partial range of a file use the slice method s3 ts const partial s3file slice 0 1024 read the partial range as a uint8array const bytes await partial bytes read the partial range as a string const text await partial text internally bun uses the http range header to request only the bytes you want this slice method is the same as blob prototype slice deleting files from s3 to delete a file from s3 use the delete method s3 ts await s3file delete await s3file unlink delete is the same as unlink error codes when bun s s3 api throws an error the error has a code property with one of the following values err_s3_missing_credentials err_s3_invalid_method err_s3_invalid_path err_s3_invalid_endpoint err_s3_invalid_signature err_s3_invalid_session_token when the s3 service itself returns an error that is not bun it is an s3error instance an error instance with the name s3error s3client static methods the s3client class provides several static methods for interacting with s3 s3client write static to write data directly to a path in the bucket use the s3client write static method s3 ts import s3client from bun const credentials accesskeyid your access key secretaccesskey your secret key bucket my bucket endpoint https s3 us east 1 amazonaws com endpoint https account id r2 cloudflarestorage com cloudflare r2 write string await s3client write my file txt hello world write json with type await s3client write data json json stringify hello world credentials type application json write from fetch const res await fetch https example com data await s3client write data bin res credentials write with acl await s3client write public html html credentials acl public read type text html this is equivalent to calling new s3client credentials write my file txt hello world s3client presign static to generate a presigned url for an s3 file use the s3client presign static method s3 ts import s3client from bun const credentials accesskeyid your access key secretaccesskey your secret key bucket my bucket endpoint https s3 us east 1 amazonaws com endpoint https account id r2 cloudflarestorage com cloudflare r2 const url s3client presign my file txt credentials expiresin 3600 this is equivalent to calling new s3client credentials presign my file txt expiresin 3600 s3client list static to list some or all up to 1 000 objects in a bucket use the s3client list static method s3 ts import s3client from bun const credentials accesskeyid your access key secretaccesskey your secret key bucket my bucket endpoint https s3 us east 1 amazonaws com endpoint https account id r2 cloudflarestorage com cloudflare r2 list up to 1000 objects in the bucket const allobjects await s3client list null credentials list up to 500 objects under uploads prefix with owner field for each object const uploads await s3client list prefix uploads maxkeys 500 fetchowner true credentials check if more results are available if uploads istruncated list next batch of objects under uploads prefix const moreuploads await s3client list prefix uploads maxkeys 500 startafter uploads contents at 1 key fetchowner true credentials this is equivalent to calling new s3client credentials list s3client exists static to check if an s3 file exists use the s3clien...