bun-types 1.2.15-canary.20250527T140539 → 1.2.15-canary.20250528T140624
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 +24 -0
- package/docs/api/fetch.md +1 -1
- package/docs/api/spawn.md +1 -1
- package/docs/bundler/html.md +32 -0
- package/docs/cli/pm.md +0 -8
- package/docs/cli/publish.md +1 -1
- package/docs/guides/ecosystem/nuxt.md +1 -1
- package/docs/guides/install/add-peer.md +2 -2
- package/docs/guides/install/from-npm-install-to-bun-install.md +1 -1
- package/docs/guides/test/run-tests.md +3 -3
- package/docs/guides/test/snapshot.md +3 -3
- package/docs/guides/test/update-snapshots.md +1 -1
- package/docs/guides/util/version.md +1 -1
- package/docs/install/audit.md +4 -4
- package/docs/installation.md +4 -4
- package/docs/runtime/debugger.md +3 -3
- package/docs/test/dom.md +1 -1
- package/package.json +1 -1
package/bun.d.ts
CHANGED
|
@@ -3357,6 +3357,30 @@ declare module "bun" {
|
|
|
3357
3357
|
* @default false
|
|
3358
3358
|
*/
|
|
3359
3359
|
console?: boolean;
|
|
3360
|
+
|
|
3361
|
+
/**
|
|
3362
|
+
* Enable automatic workspace folders for Chrome DevTools
|
|
3363
|
+
*
|
|
3364
|
+
* This lets you persistently edit files in the browser. It works by adding the following route to the server:
|
|
3365
|
+
* `/.well-known/appspecific/com.chrome.devtools.json`
|
|
3366
|
+
*
|
|
3367
|
+
* The response is a JSON object with the following shape:
|
|
3368
|
+
* ```json
|
|
3369
|
+
* {
|
|
3370
|
+
* "workspace": {
|
|
3371
|
+
* "root": "<cwd>",
|
|
3372
|
+
* "uuid": "<uuid>"
|
|
3373
|
+
* }
|
|
3374
|
+
* }
|
|
3375
|
+
* ```
|
|
3376
|
+
*
|
|
3377
|
+
* The `root` field is the current working directory of the server.
|
|
3378
|
+
* The `"uuid"` field is a hash of the file that started the server and a hash of the current working directory.
|
|
3379
|
+
*
|
|
3380
|
+
* For security reasons, if the remote socket address is not from localhost, 127.0.0.1, or ::1, the request is ignored.
|
|
3381
|
+
* @default true
|
|
3382
|
+
*/
|
|
3383
|
+
chromeDevToolsAutomaticWorkspaceFolders?: boolean;
|
|
3360
3384
|
};
|
|
3361
3385
|
|
|
3362
3386
|
error?: (this: Server, error: ErrorLike) => Response | Promise<Response> | void | Promise<void>;
|
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.15-canary.
|
|
340
|
+
[fetch] > User-Agent: Bun/1.2.15-canary.20250528T140624
|
|
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.15-canary.
|
|
123
|
+
console.log(text); // => "1.2.15-canary.20250528T140624"
|
|
124
124
|
```
|
|
125
125
|
|
|
126
126
|
Configure the output stream by passing one of the following values to `stdout/stderr`:
|
package/docs/bundler/html.md
CHANGED
|
@@ -206,6 +206,38 @@ Each call to `console.log` or `console.error` will be broadcast to the terminal
|
|
|
206
206
|
|
|
207
207
|
Internally, this reuses the existing WebSocket connection from hot module reloading to send the logs.
|
|
208
208
|
|
|
209
|
+
### Edit files in the browser
|
|
210
|
+
|
|
211
|
+
Bun's frontend dev server has support for [Automatic Workspace Folders](https://chromium.googlesource.com/devtools/devtools-frontend/+/main/docs/ecosystem/automatic_workspace_folders.md) in Chrome DevTools, which lets you save edits to files in the browser.
|
|
212
|
+
|
|
213
|
+
{% image src="/images/bun-chromedevtools.gif" alt="Bun's frontend dev server has support for Automatic Workspace Folders in Chrome DevTools, which lets you save edits to files in the browser." /%}
|
|
214
|
+
|
|
215
|
+
{% details summary="How it works" %}
|
|
216
|
+
|
|
217
|
+
Bun's dev server automatically adds a `/.well-known/appspecific/com.chrome.devtools.json` route to the server.
|
|
218
|
+
|
|
219
|
+
This route returns a JSON object with the following shape:
|
|
220
|
+
|
|
221
|
+
```json
|
|
222
|
+
{
|
|
223
|
+
"workspace": {
|
|
224
|
+
"root": "/path/to/your/project",
|
|
225
|
+
"uuid": "a-unique-identifier-for-this-workspace"
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
For security reasons, this is only enabled when:
|
|
231
|
+
|
|
232
|
+
1. The request is coming from localhost, 127.0.0.1, or ::1.
|
|
233
|
+
2. Hot Module Reloading is enabled.
|
|
234
|
+
3. The `chromeDevToolsAutomaticWorkspaceFolders` flag is set to `true` or `undefined`.
|
|
235
|
+
4. There are no other routes that match the request.
|
|
236
|
+
|
|
237
|
+
You can disable this by passing `development: { chromeDevToolsAutomaticWorkspaceFolders: false }` in `Bun.serve`'s options.
|
|
238
|
+
|
|
239
|
+
{% /details %}
|
|
240
|
+
|
|
209
241
|
## Keyboard Shortcuts
|
|
210
242
|
|
|
211
243
|
While the server is running:
|
package/docs/cli/pm.md
CHANGED
|
@@ -95,14 +95,6 @@ To print the hash stored in the current lockfile:
|
|
|
95
95
|
$ bun pm hash-print
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
## audit
|
|
99
|
-
|
|
100
|
-
To run a security audit for packages in bun.lock or bun.lockb
|
|
101
|
-
|
|
102
|
-
```bash
|
|
103
|
-
$ bun pm audit
|
|
104
|
-
```
|
|
105
|
-
|
|
106
98
|
## cache
|
|
107
99
|
|
|
108
100
|
To print the path to Bun's global module cache:
|
package/docs/cli/publish.md
CHANGED
|
@@ -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.15-canary.
|
|
12
|
+
bun install v1.2.15-canary.20250528T140624 (16b4bf34)
|
|
13
13
|
+ @nuxt/devtools@0.8.2
|
|
14
14
|
+ nuxt@3.7.0
|
|
15
15
|
785 packages installed [2.67s]
|
|
@@ -15,7 +15,7 @@ This will add the package to `peerDependencies` in `package.json`.
|
|
|
15
15
|
```json-diff
|
|
16
16
|
{
|
|
17
17
|
"peerDependencies": {
|
|
18
|
-
+ "@types/bun": "^1.2.15-canary.
|
|
18
|
+
+ "@types/bun": "^1.2.15-canary.20250528T140624"
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
21
|
```
|
|
@@ -27,7 +27,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
|
|
|
27
27
|
```json-diff
|
|
28
28
|
{
|
|
29
29
|
"peerDependencies": {
|
|
30
|
-
"@types/bun": "^1.2.15-canary.
|
|
30
|
+
"@types/bun": "^1.2.15-canary.20250528T140624"
|
|
31
31
|
},
|
|
32
32
|
"peerDependenciesMeta": {
|
|
33
33
|
+ "@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.15-canary.
|
|
100
|
+
$ bun update @types/bun@1.2.15-canary.20250528T140624
|
|
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.15-canary.
|
|
24
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
50
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
88
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
21
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
64
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
81
|
+
bun test v1.2.15-canary.20250528T140624 (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.15-canary.
|
|
32
|
+
bun test v1.2.15-canary.20250528T140624 (9c68abdb)
|
|
33
33
|
|
|
34
34
|
test/snap.test.ts:
|
|
35
35
|
✓ snapshot [0.86ms]
|
package/docs/install/audit.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
`bun
|
|
1
|
+
`bun audit` checks your installed packages for known security vulnerabilities.
|
|
2
2
|
|
|
3
3
|
Run the command in a project with a `bun.lock` file:
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
|
-
$ bun
|
|
6
|
+
$ bun audit
|
|
7
7
|
```
|
|
8
8
|
|
|
9
9
|
Bun sends the list of installed packages and versions to NPM, and prints a report of any vulnerabilities that were found. Packages installed from registries other than the default registry are skipped.
|
|
@@ -29,9 +29,9 @@ To update all dependencies to the latest versions (including breaking changes):
|
|
|
29
29
|
Use the `--json` flag to print the raw JSON response from the registry instead of the formatted report:
|
|
30
30
|
|
|
31
31
|
```bash
|
|
32
|
-
$ bun
|
|
32
|
+
$ bun audit --json
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
### Exit code
|
|
36
36
|
|
|
37
|
-
`bun
|
|
37
|
+
`bun audit` will exit with code `0` if no vulnerabilities are found and `1` if the report lists any vulnerabilities. This will still happen even if `--json` is passed.
|
package/docs/installation.md
CHANGED
|
@@ -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.15-canary.
|
|
17
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.15-canary.20250528T140624"
|
|
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.15-canary.
|
|
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.15-canary.20250528T140624`.
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
|
-
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.15-canary.
|
|
195
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.15-canary.20250528T140624"
|
|
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.15-canary.
|
|
204
|
+
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.15-canary.20250528T140624"
|
|
205
205
|
```
|
|
206
206
|
|
|
207
207
|
## Downloading Bun binaries directly
|
package/docs/runtime/debugger.md
CHANGED
|
@@ -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.15-canary.
|
|
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.15-canary.20250528T140624" -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.15-canary.
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.15-canary.20250528T140624
|
|
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.15-canary.
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.15-canary.20250528T140624
|
|
174
174
|
[fetch] > Accept: */*
|
|
175
175
|
[fetch] > Host: example.com
|
|
176
176
|
[fetch] > Accept-Encoding: gzip, deflate, br
|
package/docs/test/dom.md
CHANGED
package/package.json
CHANGED