bun-types 1.2.19-canary.20250715T140719 → 1.2.19-canary.20250716T140648
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 +13 -0
- package/docs/api/fetch.md +1 -1
- package/docs/api/spawn.md +1 -1
- package/docs/cli/pm.md +36 -1
- package/docs/cli/publish.md +1 -1
- package/docs/cli/why.md +67 -0
- 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/catalogs.md +2 -0
- 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
|
@@ -2512,6 +2512,19 @@ declare module "bun" {
|
|
|
2512
2512
|
* This defaults to `true`.
|
|
2513
2513
|
*/
|
|
2514
2514
|
throw?: boolean;
|
|
2515
|
+
|
|
2516
|
+
/**
|
|
2517
|
+
* Custom tsconfig.json file path to use for path resolution.
|
|
2518
|
+
* Equivalent to `--tsconfig-override` in the CLI.
|
|
2519
|
+
* @example
|
|
2520
|
+
* ```ts
|
|
2521
|
+
* await Bun.build({
|
|
2522
|
+
* entrypoints: ['./src/index.ts'],
|
|
2523
|
+
* tsconfig: './custom-tsconfig.json'
|
|
2524
|
+
* });
|
|
2525
|
+
* ```
|
|
2526
|
+
*/
|
|
2527
|
+
tsconfig?: string;
|
|
2515
2528
|
}
|
|
2516
2529
|
|
|
2517
2530
|
/**
|
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.19-canary.
|
|
340
|
+
[fetch] > User-Agent: Bun/1.2.19-canary.20250716T140648
|
|
341
341
|
[fetch] > Accept: */*
|
|
342
342
|
[fetch] > Host: example.com
|
|
343
343
|
[fetch] > Accept-Encoding: gzip, deflate, br
|
package/docs/api/spawn.md
CHANGED
|
@@ -140,7 +140,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
|
|
|
140
140
|
```ts
|
|
141
141
|
const proc = Bun.spawn(["bun", "--version"]);
|
|
142
142
|
const text = await proc.stdout.text();
|
|
143
|
-
console.log(text); // => "1.2.19-canary.
|
|
143
|
+
console.log(text); // => "1.2.19-canary.20250716T140648\n"
|
|
144
144
|
```
|
|
145
145
|
|
|
146
146
|
Configure the output stream by passing one of the following values to `stdout/stderr`:
|
package/docs/cli/pm.md
CHANGED
|
@@ -213,7 +213,7 @@ To display current package version and help:
|
|
|
213
213
|
|
|
214
214
|
```bash
|
|
215
215
|
$ bun pm version
|
|
216
|
-
bun pm version v1.2.19-canary.
|
|
216
|
+
bun pm version v1.2.19-canary.20250716T140648 (ca7428e9)
|
|
217
217
|
Current package version: v1.0.0
|
|
218
218
|
|
|
219
219
|
Increment:
|
|
@@ -248,3 +248,38 @@ v1.0.1
|
|
|
248
248
|
```
|
|
249
249
|
|
|
250
250
|
Supports `patch`, `minor`, `major`, `premajor`, `preminor`, `prepatch`, `prerelease`, `from-git`, or specific versions like `1.2.3`. By default creates git commit and tag unless `--no-git-tag-version` was used to skip.
|
|
251
|
+
|
|
252
|
+
## pkg
|
|
253
|
+
|
|
254
|
+
Manage `package.json` data with get, set, delete, and fix operations.
|
|
255
|
+
|
|
256
|
+
All commands support dot and bracket notation:
|
|
257
|
+
|
|
258
|
+
```bash
|
|
259
|
+
scripts.build # dot notation
|
|
260
|
+
contributors[0] # array access
|
|
261
|
+
workspaces.0 # dot with numeric index
|
|
262
|
+
scripts[test:watch] # bracket for special chars
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
Examples:
|
|
266
|
+
|
|
267
|
+
```bash
|
|
268
|
+
# set
|
|
269
|
+
$ bun pm pkg get name # single property
|
|
270
|
+
$ bun pm pkg get name version # multiple properties
|
|
271
|
+
$ bun pm pkg get # entire package.json
|
|
272
|
+
$ bun pm pkg get scripts.build # nested property
|
|
273
|
+
|
|
274
|
+
# set
|
|
275
|
+
$ bun pm pkg set name="my-package" # simple property
|
|
276
|
+
$ bun pm pkg set scripts.test="jest" version=2.0.0 # multiple properties
|
|
277
|
+
$ bun pm pkg set {"private":"true"} --json # JSON values with --json flag
|
|
278
|
+
|
|
279
|
+
# delete
|
|
280
|
+
$ bun pm pkg delete description # single property
|
|
281
|
+
$ bun pm pkg delete scripts.test contributors[0] # multiple/nested
|
|
282
|
+
|
|
283
|
+
# fix
|
|
284
|
+
$ bun pm pkg fix # auto-fix common issues
|
|
285
|
+
```
|
package/docs/cli/publish.md
CHANGED
package/docs/cli/why.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
The `bun why` command explains why a package is installed in your project by showing the dependency chain that led to its installation.
|
|
2
|
+
|
|
3
|
+
## Usage
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
$ bun why <package>
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Arguments
|
|
10
|
+
|
|
11
|
+
- `<package>`: The name of the package to explain. Supports glob patterns like `@org/*` or `*-lodash`.
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
- `--top`: Show only the top-level dependencies instead of the complete dependency tree.
|
|
16
|
+
- `--depth <number>`: Maximum depth of the dependency tree to display.
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Check why a specific package is installed:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
$ bun why react
|
|
24
|
+
react@18.2.0
|
|
25
|
+
└─ my-app@1.0.0 (requires ^18.0.0)
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Check why all packages with a specific pattern are installed:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
$ bun why "@types/*"
|
|
32
|
+
@types/react@18.2.15
|
|
33
|
+
└─ dev my-app@1.0.0 (requires ^18.0.0)
|
|
34
|
+
|
|
35
|
+
@types/react-dom@18.2.7
|
|
36
|
+
└─ dev my-app@1.0.0 (requires ^18.0.0)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Show only top-level dependencies:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
$ bun why express --top
|
|
43
|
+
express@4.18.2
|
|
44
|
+
└─ my-app@1.0.0 (requires ^4.18.2)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Limit the dependency tree depth:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
$ bun why express --depth 2
|
|
51
|
+
express@4.18.2
|
|
52
|
+
└─ express-pollyfill@1.20.1 (requires ^4.18.2)
|
|
53
|
+
└─ body-parser@1.20.1 (requires ^1.20.1)
|
|
54
|
+
└─ accepts@1.3.8 (requires ^1.3.8)
|
|
55
|
+
└─ (deeper dependencies hidden)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Understanding the Output
|
|
59
|
+
|
|
60
|
+
The output shows:
|
|
61
|
+
|
|
62
|
+
- The package name and version being queried
|
|
63
|
+
- The dependency chain that led to its installation
|
|
64
|
+
- The type of dependency (dev, peer, optional, or production)
|
|
65
|
+
- The version requirement specified in each package's dependencies
|
|
66
|
+
|
|
67
|
+
For nested dependencies, the command shows the complete dependency tree by default, with indentation indicating the relationship hierarchy.
|
|
@@ -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.19-canary.
|
|
12
|
+
bun install v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
18
|
+
+ "@types/bun": "^1.2.19-canary.20250716T140648"
|
|
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.19-canary.
|
|
30
|
+
"@types/bun": "^1.2.19-canary.20250716T140648"
|
|
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.19-canary.
|
|
100
|
+
$ bun update @types/bun@1.2.19-canary.20250716T140648
|
|
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.19-canary.
|
|
24
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
50
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
88
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
21
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
64
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
81
|
+
bun test v1.2.19-canary.20250716T140648 (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.19-canary.
|
|
32
|
+
bun test v1.2.19-canary.20250716T140648 (9c68abdb)
|
|
33
33
|
|
|
34
34
|
test/snap.test.ts:
|
|
35
35
|
✓ snapshot [0.86ms]
|
package/docs/install/catalogs.md
CHANGED
|
@@ -52,6 +52,8 @@ In your root-level `package.json`, add a `catalog` or `catalogs` field within th
|
|
|
52
52
|
}
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
+
If you put `catalog` or `catalogs` at the top level of the `package.json` file, that will work too.
|
|
56
|
+
|
|
55
57
|
### 2. Reference Catalog Versions in Workspace Packages
|
|
56
58
|
|
|
57
59
|
In your workspace packages, use the `catalog:` protocol to reference versions:
|
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.com/install | bash # for macOS, Linux, and WSL
|
|
16
16
|
# to install a specific version
|
|
17
|
-
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.
|
|
17
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250716T140648"
|
|
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.19-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.19-canary.20250716T140648`.
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
|
-
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.
|
|
195
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.19-canary.20250716T140648"
|
|
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.com/install.ps1)} -Version 1.2.19-canary.
|
|
204
|
+
$ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.19-canary.20250716T140648"
|
|
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.19-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.19-canary.20250716T140648" -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.19-canary.
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.19-canary.20250716T140648
|
|
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.19-canary.
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.19-canary.20250716T140648
|
|
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