bun-types 1.2.10-canary.20250410T140617 → 1.2.10-canary.20250412T140529

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/api/fetch.md CHANGED
@@ -337,7 +337,7 @@ This will print the request and response headers to your terminal:
337
337
  ```sh
338
338
  [fetch] > HTTP/1.1 GET http://example.com/
339
339
  [fetch] > Connection: keep-alive
340
- [fetch] > User-Agent: Bun/1.2.10-canary.20250410T140617
340
+ [fetch] > User-Agent: Bun/1.2.10-canary.20250412T140529
341
341
  [fetch] > Accept: */*
342
342
  [fetch] > Host: example.com
343
343
  [fetch] > Accept-Encoding: gzip, deflate, br
package/docs/api/s3.md CHANGED
@@ -619,6 +619,48 @@ When the S3 Object Storage service returns an error (that is, not Bun), it will
619
619
 
620
620
  The `S3Client` class provides several static methods for interacting with S3.
621
621
 
622
+ ### `S3Client.write` (static)
623
+
624
+ To write data directly to a path in the bucket, you can use the `S3Client.write` static method.
625
+
626
+ ```ts
627
+ import { S3Client } from "bun";
628
+
629
+ const credentials = {
630
+ accessKeyId: "your-access-key",
631
+ secretAccessKey: "your-secret-key",
632
+ bucket: "my-bucket",
633
+ // endpoint: "https://s3.us-east-1.amazonaws.com",
634
+ // endpoint: "https://<account-id>.r2.cloudflarestorage.com", // Cloudflare R2
635
+ };
636
+
637
+ // Write string
638
+ await S3Client.write("my-file.txt", "Hello World");
639
+
640
+ // Write JSON with type
641
+ await S3Client.write(
642
+ "data.json",
643
+ JSON.stringify({hello: "world"}),
644
+ {
645
+ ...credentials,
646
+ type: "application/json",
647
+ }
648
+ );
649
+
650
+ // Write from fetch
651
+ const res = await fetch("https://example.com/data");
652
+ await S3Client.write("data.bin", res, credentials);
653
+
654
+ // Write with ACL
655
+ await S3Client.write("public.html", html, {
656
+ ...credentials,
657
+ acl: "public-read",
658
+ type: "text/html"
659
+ });
660
+ ```
661
+
662
+ This is equivalent to calling `new S3Client(credentials).write("my-file.txt", "Hello World")`.
663
+
622
664
  ### `S3Client.presign` (static)
623
665
 
624
666
  To generate a presigned URL for an S3 file, you can use the `S3Client.presign` static method.
@@ -642,6 +684,45 @@ const url = S3Client.presign("my-file.txt", {
642
684
 
643
685
  This is equivalent to calling `new S3Client(credentials).presign("my-file.txt", { expiresIn: 3600 })`.
644
686
 
687
+ ### `S3Client.list` (static)
688
+
689
+ To list some or all (up to 1,000) objects in a bucket, you can use the `S3Client.list` static method.
690
+
691
+ ```ts
692
+ import { S3Client } from "bun";
693
+
694
+ const credentials = {
695
+ accessKeyId: "your-access-key",
696
+ secretAccessKey: "your-secret-key",
697
+ bucket: "my-bucket",
698
+ // endpoint: "https://s3.us-east-1.amazonaws.com",
699
+ // endpoint: "https://<account-id>.r2.cloudflarestorage.com", // Cloudflare R2
700
+ };
701
+
702
+ // List (up to) 1000 objects in the bucket
703
+ const allObjects = await S3Client.list(null, credentials);
704
+
705
+ // List (up to) 500 objects under `uploads/` prefix, with owner field for each object
706
+ const uploads = await S3Client.list({
707
+ prefix: 'uploads/',
708
+ maxKeys: 500,
709
+ fetchOwner: true,
710
+ }, credentials);
711
+
712
+ // Check if more results are available
713
+ if (uploads.isTruncated) {
714
+ // List next batch of objects under `uploads/` prefix
715
+ const moreUploads = await S3Client.list({
716
+ prefix: 'uploads/',
717
+ maxKeys: 500,
718
+ startAfter: uploads.contents!.at(-1).key
719
+ fetchOwner: true,
720
+ }, credentials);
721
+ }
722
+ ```
723
+
724
+ This is equivalent to calling `new S3Client(credentials).list()`.
725
+
645
726
  ### `S3Client.exists` (static)
646
727
 
647
728
  To check if an S3 file exists, you can use the `S3Client.exists` static method.
@@ -654,6 +735,7 @@ const credentials = {
654
735
  secretAccessKey: "your-secret-key",
655
736
  bucket: "my-bucket",
656
737
  // endpoint: "https://s3.us-east-1.amazonaws.com",
738
+ // endpoint: "https://<account-id>.r2.cloudflarestorage.com", // Cloudflare R2
657
739
  };
658
740
 
659
741
  const exists = await S3Client.exists("my-file.txt", credentials);
@@ -670,6 +752,26 @@ const s3file = s3.file("my-file.txt", {
670
752
  const exists = await s3file.exists();
671
753
  ```
672
754
 
755
+ ### `S3Client.size` (static)
756
+
757
+ To quickly check the size of S3 file without downloading it, you can use the `S3Client.size` static method.
758
+
759
+ ```ts
760
+ import { S3Client } from "bun";
761
+
762
+ const credentials = {
763
+ accessKeyId: "your-access-key",
764
+ secretAccessKey: "your-secret-key",
765
+ bucket: "my-bucket",
766
+ // endpoint: "https://s3.us-east-1.amazonaws.com",
767
+ // endpoint: "https://<account-id>.r2.cloudflarestorage.com", // Cloudflare R2
768
+ };
769
+
770
+ const bytes = await S3Client.size("my-file.txt", credentials);
771
+ ```
772
+
773
+ This is equivalent to calling `new S3Client(credentials).size("my-file.txt")`.
774
+
673
775
  ### `S3Client.stat` (static)
674
776
 
675
777
  To get the size, etag, and other metadata of an S3 file, you can use the `S3Client.stat` static method.
@@ -682,6 +784,7 @@ const credentials = {
682
784
  secretAccessKey: "your-secret-key",
683
785
  bucket: "my-bucket",
684
786
  // endpoint: "https://s3.us-east-1.amazonaws.com",
787
+ // endpoint: "https://<account-id>.r2.cloudflarestorage.com", // Cloudflare R2
685
788
  };
686
789
 
687
790
  const stat = await S3Client.stat("my-file.txt", credentials);
package/docs/api/spawn.md CHANGED
@@ -120,7 +120,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
120
120
  ```ts
121
121
  const proc = Bun.spawn(["bun", "--version"]);
122
122
  const text = await new Response(proc.stdout).text();
123
- console.log(text); // => "1.2.10-canary.20250410T140617"
123
+ console.log(text); // => "1.2.10-canary.20250412T140529"
124
124
  ```
125
125
 
126
126
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -7,7 +7,7 @@ Use `bun publish` to publish a package to the npm registry.
7
7
  $ bun publish
8
8
 
9
9
  ## Output
10
- bun publish v1.2.10-canary.20250410T140617 (ca7428e9)
10
+ bun publish v1.2.10-canary.20250412T140529 (ca7428e9)
11
11
 
12
12
  packed 203B package.json
13
13
  packed 224B README.md
@@ -9,7 +9,7 @@ $ bunx nuxi init my-nuxt-app
9
9
  ✔ Which package manager would you like to use?
10
10
  bun
11
11
  ◐ Installing dependencies...
12
- bun install v1.2.10-canary.20250410T140617 (16b4bf34)
12
+ bun install v1.2.10-canary.20250412T140529 (16b4bf34)
13
13
  + @nuxt/devtools@0.8.2
14
14
  + nuxt@3.7.0
15
15
  785 packages installed [2.67s]
@@ -16,7 +16,7 @@ This will add the package to `peerDependencies` in `package.json`.
16
16
  ```json-diff
17
17
  {
18
18
  "peerDependencies": {
19
- + "@types/bun": "^1.2.10-canary.20250410T140617"
19
+ + "@types/bun": "^1.2.10-canary.20250412T140529"
20
20
  }
21
21
  }
22
22
  ```
@@ -28,7 +28,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
28
28
  ```json-diff
29
29
  {
30
30
  "peerDependencies": {
31
- "@types/bun": "^1.2.10-canary.20250410T140617"
31
+ "@types/bun": "^1.2.10-canary.20250412T140529"
32
32
  },
33
33
  "peerDependenciesMeta": {
34
34
  + "@types/bun": {
@@ -97,7 +97,7 @@ $ bun update
97
97
  $ bun update @types/bun --latest
98
98
 
99
99
  # Update a dependency to a specific version
100
- $ bun update @types/bun@1.2.10-canary.20250410T140617
100
+ $ bun update @types/bun@1.2.10-canary.20250412T140529
101
101
 
102
102
  # Update all dependencies to the latest versions
103
103
  $ bun update --latest
@@ -21,7 +21,7 @@ Here's what the output of a typical test run looks like. In this case, there are
21
21
 
22
22
  ```sh
23
23
  $ bun test
24
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
24
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
25
25
 
26
26
  test.test.js:
27
27
  ✓ add [0.87ms]
@@ -47,7 +47,7 @@ To only run certain test files, pass a positional argument to `bun test`. The ru
47
47
 
48
48
  ```sh
49
49
  $ bun test test3
50
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
50
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
51
51
 
52
52
  test3.test.js:
53
53
  ✓ add [1.40ms]
@@ -85,7 +85,7 @@ Adding `-t add` will only run tests with "add" in the name. This works with test
85
85
 
86
86
  ```sh
87
87
  $ bun test -t add
88
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
88
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
89
89
 
90
90
  test.test.js:
91
91
  ✓ add [1.79ms]
@@ -18,7 +18,7 @@ The first time this test is executed, Bun will evaluate the value passed into `e
18
18
 
19
19
  ```sh
20
20
  $ bun test test/snap
21
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
21
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
22
22
 
23
23
  test/snap.test.ts:
24
24
  ✓ snapshot [1.48ms]
@@ -61,7 +61,7 @@ Later, when this test file is executed again, Bun will read the snapshot file an
61
61
 
62
62
  ```sh
63
63
  $ bun test
64
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
64
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
65
65
 
66
66
  test/snap.test.ts:
67
67
  ✓ snapshot [1.05ms]
@@ -78,7 +78,7 @@ To update snapshots, use the `--update-snapshots` flag.
78
78
 
79
79
  ```sh
80
80
  $ bun test --update-snapshots
81
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
81
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
82
82
 
83
83
  test/snap.test.ts:
84
84
  ✓ snapshot [0.86ms]
@@ -29,7 +29,7 @@ To regenerate snapshots, use the `--update-snapshots` flag.
29
29
 
30
30
  ```sh
31
31
  $ bun test --update-snapshots
32
- bun test v1.2.10-canary.20250410T140617 (9c68abdb)
32
+ bun test v1.2.10-canary.20250412T140529 (9c68abdb)
33
33
 
34
34
  test/snap.test.ts:
35
35
  ✓ snapshot [0.86ms]
@@ -5,7 +5,7 @@ name: Get the current Bun version
5
5
  Get the current version of Bun in a semver format.
6
6
 
7
7
  ```ts#index.ts
8
- Bun.version; // => "1.2.10-canary.20250410T140617"
8
+ Bun.version; // => "1.2.10-canary.20250412T140529"
9
9
  ```
10
10
 
11
11
  ---
@@ -14,7 +14,7 @@ Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. Us
14
14
  ```bash#macOS/Linux_(curl)
15
15
  $ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL
16
16
  # to install a specific version
17
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.10-canary.20250410T140617"
17
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.10-canary.20250412T140529"
18
18
  ```
19
19
 
20
20
  ```bash#npm
@@ -189,10 +189,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
189
189
 
190
190
  ### Installing a specific version of Bun on Linux/Mac
191
191
 
192
- To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.10-canary.20250410T140617`.
192
+ To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.10-canary.20250412T140529`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.10-canary.20250410T140617"
195
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.10-canary.20250412T140529"
196
196
  ```
197
197
 
198
198
  ### Installing a specific version of Bun on Windows
@@ -201,7 +201,7 @@ On Windows, you can install a specific version of Bun by passing the version num
201
201
 
202
202
  ```sh
203
203
  # PowerShell:
204
- $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.10-canary.20250410T140617"
204
+ $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.10-canary.20250412T140529"
205
205
  ```
206
206
 
207
207
  ## Downloading Bun binaries directly
@@ -124,11 +124,11 @@ await fetch("https://example.com", {
124
124
  This prints the `fetch` request as a single-line `curl` command to let you copy-paste into your terminal to replicate the request.
125
125
 
126
126
  ```sh
127
- [fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.10-canary.20250410T140617" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
127
+ [fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.10-canary.20250412T140529" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
128
128
  [fetch] > HTTP/1.1 POST https://example.com/
129
129
  [fetch] > content-type: application/json
130
130
  [fetch] > Connection: keep-alive
131
- [fetch] > User-Agent: Bun/1.2.10-canary.20250410T140617
131
+ [fetch] > User-Agent: Bun/1.2.10-canary.20250412T140529
132
132
  [fetch] > Accept: */*
133
133
  [fetch] > Host: example.com
134
134
  [fetch] > Accept-Encoding: gzip, deflate, br
@@ -170,7 +170,7 @@ This prints the following to the console:
170
170
  [fetch] > HTTP/1.1 POST https://example.com/
171
171
  [fetch] > content-type: application/json
172
172
  [fetch] > Connection: keep-alive
173
- [fetch] > User-Agent: Bun/1.2.10-canary.20250410T140617
173
+ [fetch] > User-Agent: Bun/1.2.10-canary.20250412T140529
174
174
  [fetch] > Accept: */*
175
175
  [fetch] > Host: example.com
176
176
  [fetch] > Accept-Encoding: gzip, deflate, br
package/docs/test/dom.md CHANGED
@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
55
55
 
56
56
  ```bash
57
57
  $ bun test
58
- bun test v1.2.10-canary.20250410T140617
58
+ bun test v1.2.10-canary.20250412T140529
59
59
 
60
60
  dom.test.ts:
61
61
  ✓ dom test [0.82ms]
package/fetch.d.ts CHANGED
@@ -10,7 +10,12 @@
10
10
 
11
11
  declare module "bun" {
12
12
  type HeadersInit = string[][] | Record<string, string | ReadonlyArray<string>> | Headers;
13
- type BodyInit = ReadableStream | Bun.XMLHttpRequestBodyInit | URLSearchParams | AsyncGenerator<Uint8Array>;
13
+ type BodyInit =
14
+ | ReadableStream
15
+ | Bun.XMLHttpRequestBodyInit
16
+ | URLSearchParams
17
+ | AsyncGenerator<string | ArrayBuffer | ArrayBufferView>
18
+ | (() => AsyncGenerator<string | ArrayBuffer | ArrayBufferView>);
14
19
 
15
20
  namespace __internal {
16
21
  type LibOrFallbackHeaders = LibDomIsLoaded extends true ? {} : import("undici-types").Headers;
package/globals.d.ts CHANGED
@@ -12,6 +12,8 @@ declare module "bun" {
12
12
  type NodeCryptoWebcryptoSubtleCrypto = import("crypto").webcrypto.SubtleCrypto;
13
13
  type NodeCryptoWebcryptoCryptoKey = import("crypto").webcrypto.CryptoKey;
14
14
 
15
+ type LibEmptyOrWSWebSocket = LibDomIsLoaded extends true ? {} : import("ws").WebSocket;
16
+
15
17
  type LibEmptyOrNodeUtilTextEncoder = LibDomIsLoaded extends true ? {} : import("node:util").TextEncoder;
16
18
 
17
19
  type LibEmptyOrNodeUtilTextDecoder = LibDomIsLoaded extends true ? {} : import("node:util").TextDecoder;
@@ -66,6 +68,7 @@ declare var Worker: Bun.__internal.UseLibDomIfAvailable<
66
68
  }
67
69
  >;
68
70
 
71
+ interface WebSocket extends Bun.__internal.LibEmptyOrWSWebSocket {}
69
72
  /**
70
73
  * A WebSocket client implementation
71
74
  *
@@ -872,7 +875,29 @@ declare class BuildMessage {
872
875
  readonly level: "error" | "warning" | "info" | "debug" | "verbose";
873
876
  }
874
877
 
878
+ interface ErrorOptions {
879
+ /**
880
+ * The cause of the error.
881
+ */
882
+ cause?: unknown;
883
+ }
884
+
885
+ interface Error {
886
+ /**
887
+ * The cause of the error.
888
+ */
889
+ cause?: unknown;
890
+ }
891
+
875
892
  interface ErrorConstructor {
893
+ new (message?: string, options?: ErrorOptions): Error;
894
+
895
+ /**
896
+ * Check if a value is an instance of Error
897
+ *
898
+ * @param value - The value to check
899
+ * @returns True if the value is an instance of Error, false otherwise
900
+ */
876
901
  isError(value: unknown): value is Error;
877
902
 
878
903
  /**
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.2.10-canary.20250410T140617",
2
+ "version": "1.2.10-canary.20250412T140529",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",