bun-types 1.2.11-canary.20250423T140629 → 1.2.11-canary.20250425T140632

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/bun.d.ts CHANGED
@@ -6393,11 +6393,7 @@ declare module "bun" {
6393
6393
  | Response
6394
6394
  | Request;
6395
6395
 
6396
- interface OptionsObject<
6397
- In extends Writable = Writable,
6398
- Out extends Readable = Readable,
6399
- Err extends Readable = Readable,
6400
- > {
6396
+ interface OptionsObject<In extends Writable, Out extends Readable, Err extends Readable> {
6401
6397
  /**
6402
6398
  * The current working directory of the process
6403
6399
  *
@@ -6624,22 +6620,6 @@ declare module "bun" {
6624
6620
  maxBuffer?: number;
6625
6621
  }
6626
6622
 
6627
- type OptionsToSubprocess<Opts extends OptionsObject> =
6628
- Opts extends OptionsObject<infer In, infer Out, infer Err>
6629
- ? Subprocess<
6630
- // "Writable extends In" means "if In === Writable",
6631
- // aka if true that means the user didn't specify anything
6632
- Writable extends In ? "ignore" : In,
6633
- Readable extends Out ? "pipe" : Out,
6634
- Readable extends Err ? "inherit" : Err
6635
- >
6636
- : Subprocess<Writable, Readable, Readable>;
6637
-
6638
- type OptionsToSyncSubprocess<Opts extends OptionsObject> =
6639
- Opts extends OptionsObject<any, infer Out, infer Err>
6640
- ? SyncSubprocess<Readable extends Out ? "pipe" : Out, Readable extends Err ? "pipe" : Err>
6641
- : SyncSubprocess<Readable, Readable>;
6642
-
6643
6623
  type ReadableIO = ReadableStream<Uint8Array> | number | undefined;
6644
6624
 
6645
6625
  type ReadableToIO<X extends Readable> = X extends "pipe" | undefined
@@ -6746,9 +6726,9 @@ declare module "bun" {
6746
6726
  * - {@link NullSubprocess} (ignore, ignore, ignore)
6747
6727
  */
6748
6728
  interface Subprocess<
6749
- In extends SpawnOptions.Writable = SpawnOptions.Writable,
6750
- Out extends SpawnOptions.Readable = SpawnOptions.Readable,
6751
- Err extends SpawnOptions.Readable = SpawnOptions.Readable,
6729
+ In extends SpawnOptions.Writable,
6730
+ Out extends SpawnOptions.Readable,
6731
+ Err extends SpawnOptions.Readable,
6752
6732
  > extends AsyncDisposable {
6753
6733
  readonly stdin: SpawnOptions.WritableToIO<In>;
6754
6734
  readonly stdout: SpawnOptions.ReadableToIO<Out>;
@@ -6853,10 +6833,7 @@ declare module "bun" {
6853
6833
  * - {@link ReadableSyncSubprocess} (pipe, pipe)
6854
6834
  * - {@link NullSyncSubprocess} (ignore, ignore)
6855
6835
  */
6856
- interface SyncSubprocess<
6857
- Out extends SpawnOptions.Readable = SpawnOptions.Readable,
6858
- Err extends SpawnOptions.Readable = SpawnOptions.Readable,
6859
- > {
6836
+ interface SyncSubprocess<Out extends SpawnOptions.Readable, Err extends SpawnOptions.Readable> {
6860
6837
  stdout: SpawnOptions.ReadableToSyncIO<Out>;
6861
6838
  stderr: SpawnOptions.ReadableToSyncIO<Err>;
6862
6839
  exitCode: number;
@@ -6888,8 +6865,12 @@ declare module "bun" {
6888
6865
  *
6889
6866
  * Internally, this uses [posix_spawn(2)](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/posix_spawn.2.html)
6890
6867
  */
6891
- function spawn<Opts extends SpawnOptions.OptionsObject>(
6892
- options: Opts & {
6868
+ function spawn<
6869
+ const In extends SpawnOptions.Writable = "ignore",
6870
+ const Out extends SpawnOptions.Readable = "pipe",
6871
+ const Err extends SpawnOptions.Readable = "inherit",
6872
+ >(
6873
+ options: SpawnOptions.OptionsObject<In, Out, Err> & {
6893
6874
  /**
6894
6875
  * The command to run
6895
6876
  *
@@ -6906,7 +6887,7 @@ declare module "bun" {
6906
6887
  */
6907
6888
  cmd: string[]; // to support dynamically constructed commands
6908
6889
  },
6909
- ): SpawnOptions.OptionsToSubprocess<Opts>;
6890
+ ): Subprocess<In, Out, Err>;
6910
6891
 
6911
6892
  /**
6912
6893
  * Spawn a new process
@@ -6919,7 +6900,11 @@ declare module "bun" {
6919
6900
  *
6920
6901
  * Internally, this uses [posix_spawn(2)](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/posix_spawn.2.html)
6921
6902
  */
6922
- function spawn<Opts extends SpawnOptions.OptionsObject>(
6903
+ function spawn<
6904
+ const In extends SpawnOptions.Writable = "ignore",
6905
+ const Out extends SpawnOptions.Readable = "pipe",
6906
+ const Err extends SpawnOptions.Readable = "inherit",
6907
+ >(
6923
6908
  /**
6924
6909
  * The command to run
6925
6910
  *
@@ -6935,8 +6920,8 @@ declare module "bun" {
6935
6920
  * ```
6936
6921
  */
6937
6922
  cmds: string[],
6938
- options?: Opts,
6939
- ): SpawnOptions.OptionsToSubprocess<Opts>;
6923
+ options?: SpawnOptions.OptionsObject<In, Out, Err>,
6924
+ ): Subprocess<In, Out, Err>;
6940
6925
 
6941
6926
  /**
6942
6927
  * Spawn a new process
@@ -6952,8 +6937,11 @@ declare module "bun" {
6952
6937
  *
6953
6938
  * Internally, this uses [posix_spawn(2)](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/posix_spawn.2.html)
6954
6939
  */
6955
- function spawnSync<Opts extends SpawnOptions.OptionsObject>(
6956
- options: Opts & {
6940
+ function spawnSync<
6941
+ const Out extends SpawnOptions.Readable = "pipe",
6942
+ const Err extends SpawnOptions.Readable = "inherit",
6943
+ >(
6944
+ options: SpawnOptions.OptionsObject<"ignore", Out, Err> & {
6957
6945
  /**
6958
6946
  * The command to run
6959
6947
  *
@@ -6972,7 +6960,7 @@ declare module "bun" {
6972
6960
 
6973
6961
  onExit?: never;
6974
6962
  },
6975
- ): SpawnOptions.OptionsToSyncSubprocess<Opts>;
6963
+ ): SyncSubprocess<Out, Err>;
6976
6964
 
6977
6965
  /**
6978
6966
  * Synchronously spawn a new process
@@ -6984,7 +6972,10 @@ declare module "bun" {
6984
6972
  *
6985
6973
  * Internally, this uses [posix_spawn(2)](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/posix_spawn.2.html)
6986
6974
  */
6987
- function spawnSync<Opts extends SpawnOptions.OptionsObject>(
6975
+ function spawnSync<
6976
+ const Out extends SpawnOptions.Readable = "pipe",
6977
+ const Err extends SpawnOptions.Readable = "inherit",
6978
+ >(
6988
6979
  /**
6989
6980
  * The command to run
6990
6981
  *
@@ -7000,8 +6991,8 @@ declare module "bun" {
7000
6991
  * ```
7001
6992
  */
7002
6993
  cmds: string[],
7003
- options?: Opts,
7004
- ): SpawnOptions.OptionsToSyncSubprocess<Opts>;
6994
+ options?: SpawnOptions.OptionsObject<"ignore", Out, Err>,
6995
+ ): SyncSubprocess<Out, Err>;
7005
6996
 
7006
6997
  /** Utility type for any process from {@link Bun.spawn()} with both stdout and stderr set to `"pipe"` */
7007
6998
  type ReadableSubprocess = Subprocess<any, "pipe", "pipe">;
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.11-canary.20250423T140629
340
+ [fetch] > User-Agent: Bun/1.2.11-canary.20250425T140632
341
341
  [fetch] > Accept: */*
342
342
  [fetch] > Host: example.com
343
343
  [fetch] > Accept-Encoding: gzip, deflate, br
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.11-canary.20250423T140629"
123
+ console.log(text); // => "1.2.11-canary.20250425T140632"
124
124
  ```
125
125
 
126
126
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -117,14 +117,14 @@ type WebSocketData = {
117
117
  // TypeScript: specify the type of `data`
118
118
  Bun.serve<WebSocketData>({
119
119
  fetch(req, server) {
120
- // use a library to parse cookies
121
- const cookies = parseCookies(req.headers.get("Cookie"));
120
+ const cookies = new Bun.CookieMap(req.headers.get("cookie")!);
121
+
122
122
  server.upgrade(req, {
123
123
  // this object must conform to WebSocketData
124
124
  data: {
125
125
  createdAt: Date.now(),
126
126
  channelId: new URL(req.url).searchParams.get("channelId"),
127
- authToken: cookies["X-Token"],
127
+ authToken: cookies.get("X-Token"),
128
128
  },
129
129
  });
130
130
 
@@ -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.11-canary.20250423T140629 (ca7428e9)
10
+ bun publish v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (16b4bf34)
12
+ bun install v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629"
19
+ + "@types/bun": "^1.2.11-canary.20250425T140632"
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.11-canary.20250423T140629"
31
+ "@types/bun": "^1.2.11-canary.20250425T140632"
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.11-canary.20250423T140629
100
+ $ bun update @types/bun@1.2.11-canary.20250425T140632
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.11-canary.20250423T140629 (9c68abdb)
24
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
50
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
88
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
21
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
64
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
81
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629 (9c68abdb)
32
+ bun test v1.2.11-canary.20250425T140632 (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.11-canary.20250423T140629"
8
+ Bun.version; // => "1.2.11-canary.20250425T140632"
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.11-canary.20250423T140629"
17
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250425T140632"
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.11-canary.20250423T140629`.
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.11-canary.20250425T140632`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250423T140629"
195
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.11-canary.20250425T140632"
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.11-canary.20250423T140629"
204
+ $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.11-canary.20250425T140632"
205
205
  ```
206
206
 
207
207
  ## Downloading Bun binaries directly
@@ -222,6 +222,9 @@ $ git -C vendor/WebKit checkout <commit_hash>
222
222
  # Optionally, you can use `make jsc` for a release build
223
223
  $ make jsc-debug && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
224
224
 
225
+ # After an initial run of `make jsc-debug`, you can rebuild JSC with:
226
+ $ cmake --build vendor/WebKit/WebKitBuild/Debug --target jsc && rm vendor/WebKit/WebKitBuild/Debug/JavaScriptCore/DerivedSources/inspector/InspectorProtocolObjects.h
227
+
225
228
  # Build bun with the local JSC build
226
229
  $ bun run build:local
227
230
  ```
@@ -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.11-canary.20250423T140629" -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.11-canary.20250425T140632" -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.11-canary.20250423T140629
131
+ [fetch] > User-Agent: Bun/1.2.11-canary.20250425T140632
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.11-canary.20250423T140629
173
+ [fetch] > User-Agent: Bun/1.2.11-canary.20250425T140632
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.11-canary.20250423T140629
58
+ bun test v1.2.11-canary.20250425T140632
59
59
 
60
60
  dom.test.ts:
61
61
  ✓ dom test [0.82ms]
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.2.11-canary.20250423T140629",
2
+ "version": "1.2.11-canary.20250425T140632",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",
package/shell.d.ts CHANGED
@@ -6,7 +6,7 @@ declare module "bun" {
6
6
  | Array<ShellExpression>
7
7
  | string
8
8
  | { raw: string }
9
- | Subprocess
9
+ | Subprocess<SpawnOptions.Writable, SpawnOptions.Readable, SpawnOptions.Readable>
10
10
  | SpawnOptions.Readable
11
11
  | SpawnOptions.Writable
12
12
  | ReadableStream;
@@ -24,9 +24,9 @@ declare module "bun" {
24
24
  */
25
25
  function $(strings: TemplateStringsArray, ...expressions: ShellExpression[]): $.ShellPromise;
26
26
 
27
- namespace $ {
28
- const Shell: new () => typeof $;
27
+ type $ = typeof $;
29
28
 
29
+ namespace $ {
30
30
  /**
31
31
  * Perform bash-like brace expansion on the given pattern.
32
32
  * @param pattern - Brace pattern to expand
@@ -60,23 +60,23 @@ declare module "bun" {
60
60
  * // "bun"
61
61
  * ```
62
62
  */
63
- function env(newEnv?: Record<string, string | undefined>): typeof $;
63
+ function env(newEnv?: Record<string, string | undefined>): $;
64
64
 
65
65
  /**
66
66
  *
67
67
  * @param newCwd Default working directory to use for shells created by this instance.
68
68
  */
69
- function cwd(newCwd?: string): typeof $;
69
+ function cwd(newCwd?: string): $;
70
70
 
71
71
  /**
72
72
  * Configure the shell to not throw an exception on non-zero exit codes.
73
73
  */
74
- function nothrow(): typeof $;
74
+ function nothrow(): $;
75
75
 
76
76
  /**
77
77
  * Configure whether or not the shell should throw an exception on non-zero exit codes.
78
78
  */
79
- function throws(shouldThrow: boolean): typeof $;
79
+ function throws(shouldThrow: boolean): $;
80
80
 
81
81
  /**
82
82
  * The `Bun.$.ShellPromise` class represents a shell command that gets executed
@@ -375,5 +375,7 @@ declare module "bun" {
375
375
  */
376
376
  blob(): Blob;
377
377
  }
378
+
379
+ const Shell: new () => $;
378
380
  }
379
381
  }