bun-types 1.2.3-canary.20250210T140549 → 1.2.3-canary.20250211T140606

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.3-canary.20250210T140549
340
+ [fetch] > User-Agent: Bun/1.2.3-canary.20250211T140606
341
341
  [fetch] > Accept: */*
342
342
  [fetch] > Host: example.com
343
343
  [fetch] > Accept-Encoding: gzip, deflate, br
package/docs/api/spawn.md CHANGED
@@ -110,7 +110,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
110
110
  ```ts
111
111
  const proc = Bun.spawn(["bun", "--version"]);
112
112
  const text = await new Response(proc.stdout).text();
113
- console.log(text); // => "1.2.3-canary.20250210T140549"
113
+ console.log(text); // => "1.2.3-canary.20250211T140606"
114
114
  ```
115
115
 
116
116
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -1629,3 +1629,5 @@ declare class ResolveMessage {
1629
1629
  toString(): string;
1630
1630
  }
1631
1631
  ```
1632
+
1633
+ {% bunCLIUsage command="build" /%}
package/docs/cli/add.md CHANGED
@@ -169,3 +169,5 @@ This will add the following line to your `package.json`:
169
169
  }
170
170
  }
171
171
  ```
172
+
173
+ {% bunCLIUsage command="add" /%}
package/docs/cli/init.md CHANGED
@@ -38,3 +38,5 @@ If you pass `-y` or `--yes`, it will assume you want to continue without asking
38
38
  At the end, it runs `bun install` to install `@types/bun`.
39
39
 
40
40
  {% /details %}
41
+
42
+ {% bunCLIUsage command="init" /%}
@@ -235,3 +235,5 @@ jobs:
235
235
  - name: Build app
236
236
  run: bun run build
237
237
  ```
238
+
239
+ {% bunCLIUsage command="install" /%}
package/docs/cli/link.md CHANGED
@@ -36,3 +36,5 @@ In addition, the `--save` flag can be used to add `cool-pkg` to the `dependencie
36
36
  }
37
37
  }
38
38
  ```
39
+
40
+ {% bunCLIUsage command="link" /%}
@@ -43,3 +43,5 @@ You can pass multiple `--filter` flags to check multiple workspaces:
43
43
  You can also pass glob patterns to filter by workspace names:
44
44
 
45
45
  {% bunOutdatedTerminal glob="{e,t}*" displayGlob="--filter='@monorepo/{types,cli}'" /%}
46
+
47
+ {% bunCLIUsage command="outdated" /%}
@@ -7,3 +7,5 @@ To get started with patch, first prepare the package for patching with [`bun pat
7
7
  By default, `bun patch-commit` will use the `patches` directory in the temporary directory.
8
8
 
9
9
  You can specify a different directory with the `--patches-dir` flag.
10
+
11
+ {% bunCLIUsage command="patch-commit" /%}
@@ -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.3-canary.20250210T140549 (ca7428e9)
10
+ bun publish v1.2.3-canary.20250211T140606 (ca7428e9)
11
11
 
12
12
  packed 203B package.json
13
13
  packed 224B README.md
@@ -105,3 +105,4 @@ $ bun publish --otp 123456
105
105
  ### `--gzip-level`
106
106
 
107
107
  Specify the level of gzip compression to use when packing the package. Only applies to `bun publish` without a tarball path argument. Values range from `0` to `9` (default is `9`).
108
+ {% bunCLIUsage command="publish" /%}
@@ -3,3 +3,5 @@ To remove a dependency:
3
3
  ```bash
4
4
  $ bun remove ts-node
5
5
  ```
6
+
7
+ {% bunCLIUsage command="remove" /%}
package/docs/cli/run.md CHANGED
@@ -205,3 +205,5 @@ When there is a package.json script and a file with the same name, `bun run` pri
205
205
  2. Source files, eg `bun run src/main.js`
206
206
  3. Binaries from project packages, eg `bun add eslint && bun run eslint`
207
207
  4. (`bun run` only) System commands, eg `bun run ls`
208
+
209
+ {% bunCLIUsage command="run" /%}
package/docs/cli/test.md CHANGED
@@ -247,3 +247,5 @@ $ bun test foo
247
247
  ```
248
248
 
249
249
  Any test file in the directory with an _absolute path_ that contains one of the targets will run. Glob patterns are not yet supported. -->
250
+
251
+ {% bunCLIUsage command="test" /%}
@@ -5,3 +5,5 @@ $ cd /path/to/cool-pkg
5
5
  $ bun unlink
6
6
  bun unlink v1.x (7416672e)
7
7
  ```
8
+
9
+ {% bunCLIUsage command="unlink" /%}
@@ -32,3 +32,5 @@ For example, with the following `package.json`:
32
32
 
33
33
  - `bun update` would update to a version that matches `17.x`.
34
34
  - `bun update --latest` would update to a version that matches `18.x` or later.
35
+
36
+ {% bunCLIUsage command="update" /%}
@@ -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.3-canary.20250210T140549 (16b4bf34)
12
+ bun install v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549"
19
+ + "@types/bun": "^1.2.3-canary.20250211T140606"
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.3-canary.20250210T140549"
31
+ "@types/bun": "^1.2.3-canary.20250211T140606"
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.3-canary.20250210T140549
100
+ $ bun update @types/bun@1.2.3-canary.20250211T140606
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.3-canary.20250210T140549 (9c68abdb)
24
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
50
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
88
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
21
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
64
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
81
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549 (9c68abdb)
32
+ bun test v1.2.3-canary.20250211T140606 (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.3-canary.20250210T140549"
8
+ Bun.version; // => "1.2.3-canary.20250211T140606"
9
9
  ```
10
10
 
11
11
  ---
@@ -55,3 +55,5 @@ $ bun patch --commit react --patches-dir=mypatches
55
55
  # `patch-commit` is available for compatibility with pnpm
56
56
  $ bun patch-commit react
57
57
  ```
58
+
59
+ {% bunCLIUsage command="patch" /%}
@@ -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.3-canary.20250210T140549"
17
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250211T140606"
18
18
  ```
19
19
 
20
20
  ```bash#npm
@@ -94,7 +94,9 @@ $ bun --revision
94
94
 
95
95
  If you've installed Bun but are seeing a `command not found` error, you may have to manually add the installation directory (`~/.bun/bin`) to your `PATH`.
96
96
 
97
- {% details summary="How to add to your `PATH`" %}
97
+ ### How to add your `PATH`
98
+
99
+ {% details summary="Linux / Mac" %}
98
100
  First, determine what shell you're using:
99
101
 
100
102
  ```sh
@@ -129,6 +131,26 @@ Save the file. You'll need to open a new shell/terminal window for the changes t
129
131
 
130
132
  {% /details %}
131
133
 
134
+ {% details summary="Windows" %}
135
+ First, determine if the bun binary is properly installed on your system:
136
+
137
+ ```pwsh
138
+ & "$env:USERPROFILE\.bun\bin\bun" --version
139
+ ```
140
+
141
+ If the command runs successfully but `bun --version` is not recognized, it means that bun is not in your system's `PATH`. To fix this, open a Powershell terminal and run the following command:
142
+
143
+ ```pwsh
144
+ [System.Environment]::SetEnvironmentVariable(
145
+ "Path",
146
+ [System.Environment]::GetEnvironmentVariable("Path", "User") + ";$env:USERPROFILE\.bun\bin",
147
+ [System.EnvironmentVariableTarget]::User
148
+ )
149
+ ```
150
+ After running the command, restart your terminal and test with `bun --version`
151
+
152
+ {% /details %}
153
+
132
154
  ## Upgrading
133
155
 
134
156
  Once installed, the binary can upgrade itself.
@@ -166,10 +188,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
166
188
 
167
189
  ### Installing a specific version of Bun on Linux/Mac
168
190
 
169
- 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.3-canary.20250210T140549`.
191
+ 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.3-canary.20250211T140606`.
170
192
 
171
193
  ```sh
172
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250210T140549"
194
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250211T140606"
173
195
  ```
174
196
 
175
197
  ### Installing a specific version of Bun on Windows
@@ -178,7 +200,7 @@ On Windows, you can install a specific version of Bun by passing the version num
178
200
 
179
201
  ```sh
180
202
  # PowerShell:
181
- $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.20250210T140549"
203
+ $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.20250211T140606"
182
204
  ```
183
205
 
184
206
  ## 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.3-canary.20250210T140549" -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.3-canary.20250211T140606" -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.3-canary.20250210T140549
131
+ [fetch] > User-Agent: Bun/1.2.3-canary.20250211T140606
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.3-canary.20250210T140549
173
+ [fetch] > User-Agent: Bun/1.2.3-canary.20250211T140606
174
174
  [fetch] > Accept: */*
175
175
  [fetch] > Host: example.com
176
176
  [fetch] > Accept-Encoding: gzip, deflate, br
@@ -56,9 +56,9 @@ By default, `await`ing will return stdout and stderr as `Buffer`s.
56
56
  ```js
57
57
  import { $ } from "bun";
58
58
 
59
- const { stdout, stderr } = await $`echo "Hello World!"`.quiet();
59
+ const { stdout, stderr } = await $`echo "Hello!"`.quiet();
60
60
 
61
- console.log(stdout); // Buffer(6) [ 72, 101, 108, 108, 111, 32 ]
61
+ console.log(stdout); // Buffer(7) [ 72, 101, 108, 108, 111, 33, 10 ]
62
62
  console.log(stderr); // Buffer(0) []
63
63
  ```
64
64
 
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.3-canary.20250210T140549
58
+ bun test v1.2.3-canary.20250211T140606
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.3-canary.20250210T140549",
2
+ "version": "1.2.3-canary.20250211T140606",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "main": "",