bun-types 1.2.18-canary.20250622T140517 → 1.2.18-canary.20250624T140645

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.18-canary.20250622T140517
340
+ [fetch] > User-Agent: Bun/1.2.18-canary.20250624T140645
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.18-canary.20250622T140517"
123
+ console.log(text); // => "1.2.18-canary.20250624T140645"
124
124
  ```
125
125
 
126
126
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -381,7 +381,6 @@ Note: this is currently in `bunfig.toml` to make it possible to know statically
381
381
  Bun uses [`HTMLRewriter`](/docs/api/html-rewriter) to scan for `<script>` and `<link>` tags in HTML files, uses them as entrypoints for [Bun's bundler](/docs/bundler), generates an optimized bundle for the JavaScript/TypeScript/TSX/JSX and CSS files, and serves the result.
382
382
 
383
383
  1. **`<script>` processing**
384
-
385
384
  - Transpiles TypeScript, JSX, and TSX in `<script>` tags
386
385
  - Bundles imported dependencies
387
386
  - Generates sourcemaps for debugging
@@ -392,7 +391,6 @@ Bun uses [`HTMLRewriter`](/docs/api/html-rewriter) to scan for `<script>` and `<
392
391
  ```
393
392
 
394
393
  2. **`<link>` processing**
395
-
396
394
  - Processes CSS imports and `<link>` tags
397
395
  - Concatenates CSS files
398
396
  - Rewrites `url` and asset paths to include content-addressable hashes in URLs
@@ -402,18 +400,15 @@ Bun uses [`HTMLRewriter`](/docs/api/html-rewriter) to scan for `<script>` and `<
402
400
  ```
403
401
 
404
402
  3. **`<img>` & asset processing**
405
-
406
403
  - Links to assets are rewritten to include content-addressable hashes in URLs
407
404
  - Small assets in CSS files are inlined into `data:` URLs, reducing the total number of HTTP requests sent over the wire
408
405
 
409
406
  4. **Rewrite HTML**
410
-
411
407
  - Combines all `<script>` tags into a single `<script>` tag with a content-addressable hash in the URL
412
408
  - Combines all `<link>` tags into a single `<link>` tag with a content-addressable hash in the URL
413
409
  - Outputs a new HTML file
414
410
 
415
411
  5. **Serve**
416
-
417
412
  - All the output files from the bundler are exposed as static routes, using the same mechanism internally as when you pass a `Response` object to [`static` in `Bun.serve()`](/docs/api/http#static-routes).
418
413
 
419
414
  This works similarly to how [`Bun.build` processes HTML files](/docs/bundler/html).
@@ -308,14 +308,12 @@ IF remote template
308
308
  1. GET `registry.npmjs.org/@bun-examples/${template}/latest` and parse it
309
309
  2. GET `registry.npmjs.org/@bun-examples/${template}/-/${template}-${latestVersion}.tgz`
310
310
  3. Decompress & extract `${template}-${latestVersion}.tgz` into `${destination}`
311
-
312
311
  - If there are files that would overwrite, warn and exit unless `--force` is passed
313
312
 
314
313
  IF GitHub repo
315
314
 
316
315
  1. Download the tarball from GitHub’s API
317
316
  2. Decompress & extract into `${destination}`
318
-
319
317
  - If there are files that would overwrite, warn and exit unless `--force` is passed
320
318
 
321
319
  ELSE IF local template
@@ -333,7 +331,6 @@ ELSE IF local template
333
331
  7. Run `${npmClient} install` unless `--no-install` is passed OR no dependencies are in package.json
334
332
  8. Run any tasks defined in `"bun-create": { "postinstall" }` with the npm client
335
333
  9. Run `git init; git add -A .; git commit -am "Initial Commit";`
336
-
337
334
  - Rename `gitignore` to `.gitignore`. NPM automatically removes `.gitignore` files from appearing in packages.
338
335
  - If there are dependencies, this runs in a separate thread concurrently while node_modules are being installed
339
336
  - Using libgit2 if available was tested and performed 3x slower in microbenchmarks
@@ -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.18-canary.20250622T140517 (ca7428e9)
10
+ bun publish v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (16b4bf34)
12
+ bun install v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517"
18
+ + "@types/bun": "^1.2.18-canary.20250624T140645"
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.18-canary.20250622T140517"
30
+ "@types/bun": "^1.2.18-canary.20250624T140645"
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.18-canary.20250622T140517
100
+ $ bun update @types/bun@1.2.18-canary.20250624T140645
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.18-canary.20250622T140517 (9c68abdb)
24
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
50
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
88
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
21
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
64
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
81
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517 (9c68abdb)
32
+ bun test v1.2.18-canary.20250624T140645 (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.18-canary.20250622T140517"
8
+ Bun.version; // => "1.2.18-canary.20250624T140645"
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.18-canary.20250622T140517"
17
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250624T140645"
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.18-canary.20250622T140517`.
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.18-canary.20250624T140645`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250622T140517"
195
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250624T140645"
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.18-canary.20250622T140517"
204
+ $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.18-canary.20250624T140645"
205
205
  ```
206
206
 
207
207
  ## Downloading Bun binaries directly
@@ -144,6 +144,14 @@ $ bun bd test foo.test.ts
144
144
  $ bun bd ./foo.ts
145
145
  ```
146
146
 
147
+ Bun generally takes about 2.5 minutes to compile a debug build when there are Zig changes. If your development workflow is "change one line, save, rebuild", you will spend too much time waiting for the build to finish. Instead:
148
+
149
+ - Batch up your changes
150
+ - Ensure zls is running with incremental watching for LSP errors (if you use VSCode and install Zig and run `bun run build` once to download Zig, this should just work)
151
+ - Prefer using the debugger ("CodeLLDB" in VSCode) to step through the code.
152
+ - Use debug logs. `BUN_DEBUG_<scope>=1` will enable debug logging for the corresponding `Output.scoped(.<scope>, false)` logs. You can also set `BUN_DEBUG_QUIET_LOGS=1` to disable all debug logging that isn't explicitly enabled. To dump debug lgos into a file, `BUN_DEBUG=<path-to-file>.log`. Debug logs are aggressively removed in release builds.
153
+ - src/js/\*\*.ts changes are pretty much instant to rebuild. C++ changes are a bit slower, but still much faster than the Zig code (Zig is one compilation unit, C++ is many).
154
+
147
155
  ## Code generation scripts
148
156
 
149
157
  Several code generation scripts are used during Bun's build process. These are run automatically when changes are made to certain files.
@@ -179,6 +187,7 @@ To run a release build from a pull request, you can use the `bun-pr` npm package
179
187
  bunx bun-pr <pr-number>
180
188
  bunx bun-pr <branch-name>
181
189
  bunx bun-pr "https://github.com/oven-sh/bun/pull/1234566"
190
+ bunx bun-pr --asan <pr-number> # Linux x64 only
182
191
  ```
183
192
 
184
193
  This will download the release build from the pull request and add it to `$PATH` as `bun-${pr-number}`. You can then run the build with `bun-${pr-number}`.
@@ -189,24 +198,18 @@ bun-1234566 --version
189
198
 
190
199
  This works by downloading the release build from the GitHub Actions artifacts on the linked pull request. You may need the `gh` CLI installed to authenticate with GitHub.
191
200
 
192
- ## Valgrind
193
-
194
- On Linux, valgrind can help find memory issues.
201
+ ## AddressSanitizer
195
202
 
196
- Keep in mind:
203
+ [AddressSanitizer](https://en.wikipedia.org/wiki/AddressSanitizer) helps find memory issues, and is enabled by default in debug builds of Bun on Linux and macOS. This includes the Zig code and all dependencies. It makes the Zig code take about 2x longer to build, if that's stopping you from being productive you can disable it by setting `-Denable_asan=$<IF:$<BOOL:${ENABLE_ASAN}>,true,false>` to `-Denable_asan=false` in the `cmake/targets/BuildBun.cmake` file, but generally we recommend batching your changes up between builds.
197
204
 
198
- - JavaScriptCore doesn't support valgrind. It will report spurious errors.
199
- - Valgrind is slow
200
- - Mimalloc will sometimes cause spurious errors when debug build is enabled
201
-
202
- You'll need a very recent version of Valgrind due to DWARF 5 debug symbols. You may need to manually compile Valgrind instead of using it from your Linux package manager.
203
-
204
- `--fair-sched=try` is necessary if running multithreaded code in Bun (such as the bundler). Otherwise it will hang.
205
+ To build a release build with Address Sanitizer, run:
205
206
 
206
207
  ```bash
207
- $ valgrind --fair-sched=try --track-origins=yes bun-debug <args>
208
+ $ bun run build:release:asan
208
209
  ```
209
210
 
211
+ In CI, we run our test suite with at least one target that is built with Address Sanitizer.
212
+
210
213
  ## Building WebKit locally + Debug mode of JSC
211
214
 
212
215
  WebKit is not cloned by default (to save time and disk space). To clone and build WebKit locally, run:
@@ -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.18-canary.20250622T140517" -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.18-canary.20250624T140645" -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.18-canary.20250622T140517
131
+ [fetch] > User-Agent: Bun/1.2.18-canary.20250624T140645
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.18-canary.20250622T140517
173
+ [fetch] > User-Agent: Bun/1.2.18-canary.20250624T140645
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.18-canary.20250622T140517
58
+ bun test v1.2.18-canary.20250624T140645
59
59
 
60
60
  dom.test.ts:
61
61
  ✓ dom test [0.82ms]
@@ -206,13 +206,11 @@ Understanding how `mock.module()` works helps you use it more effectively:
206
206
  2. **Lazy Evaluation**: The mock factory callback is only evaluated when the module is actually imported or required.
207
207
 
208
208
  3. **Path Resolution**: Bun automatically resolves the module specifier as though you were doing an import, supporting:
209
-
210
209
  - Relative paths (`'./module'`)
211
210
  - Absolute paths (`'/path/to/module'`)
212
211
  - Package names (`'lodash'`)
213
212
 
214
213
  4. **Import Timing Effects**:
215
-
216
214
  - When mocking before first import: No side effects from the original module occur
217
215
  - When mocking after import: The original module's side effects have already happened
218
216
  - For this reason, using `--preload` is recommended for mocks that need to prevent side effects
package/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.2.18-canary.20250622T140517",
2
+ "version": "1.2.18-canary.20250624T140645",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",