bun-types 1.2.21-canary.20250823T140535 → 1.2.21-canary.20250824T140615

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
@@ -336,7 +336,7 @@ This will print the request and response headers to your terminal:
336
336
  ```sh
337
337
  [fetch] > HTTP/1.1 GET http://example.com/
338
338
  [fetch] > Connection: keep-alive
339
- [fetch] > User-Agent: Bun/1.2.21-canary.20250823T140535
339
+ [fetch] > User-Agent: Bun/1.2.21-canary.20250824T140615
340
340
  [fetch] > Accept: */*
341
341
  [fetch] > Host: example.com
342
342
  [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.21-canary.20250823T140535\n"
143
+ console.log(text); // => "1.2.21-canary.20250824T140615\n"
144
144
  ```
145
145
 
146
146
  Configure the output stream by passing one of the following values to `stdout/stderr`:
package/docs/api/yaml.md CHANGED
@@ -436,9 +436,8 @@ bun build app.ts --outdir=dist
436
436
  This means:
437
437
 
438
438
  - Zero runtime YAML parsing overhead in production
439
- - Smaller bundle sizes (no YAML parser needed)
440
- - Type safety with TypeScript
441
- - Tree-shaking support for unused configuration
439
+ - Smaller bundle sizes
440
+ - Tree-shaking support for unused configuration (named imports)
442
441
 
443
442
  ### Dynamic Imports
444
443
 
@@ -458,73 +457,3 @@ async function loadUserSettings(userId: string) {
458
457
  }
459
458
  }
460
459
  ```
461
-
462
- ## Use Cases
463
-
464
- ### Testing and Fixtures
465
-
466
- YAML works well for test fixtures and seed data:
467
-
468
- ```yaml#fixtures.yaml
469
- users:
470
- - id: 1
471
- name: Alice
472
- email: alice@example.com
473
- role: admin
474
- - id: 2
475
- name: Bob
476
- email: bob@example.com
477
- role: user
478
-
479
- products:
480
- - sku: PROD-001
481
- name: Widget
482
- price: 19.99
483
- stock: 100
484
- ```
485
-
486
- ```ts
487
- import fixtures from "./fixtures.yaml";
488
- import { db } from "./database";
489
-
490
- async function seed() {
491
- await db.user.createMany({ data: fixtures.users });
492
- await db.product.createMany({ data: fixtures.products });
493
- }
494
- ```
495
-
496
- ### API Definitions
497
-
498
- YAML is commonly used for API specifications like OpenAPI:
499
-
500
- ```yaml#api.yaml
501
- openapi: 3.0.0
502
- info:
503
- title: My API
504
- version: 1.0.0
505
-
506
- paths:
507
- /users:
508
- get:
509
- summary: List users
510
- responses:
511
- 200:
512
- description: Success
513
- ```
514
-
515
- ```ts#api.ts
516
- import apiSpec from "./api.yaml";
517
- import { generateRoutes } from "./router";
518
-
519
- const routes = generateRoutes(apiSpec);
520
- ```
521
-
522
- ## Performance
523
-
524
- Bun's YAML parser is implemented in Zig for optimal performance:
525
-
526
- - **Fast parsing**: Native implementation provides excellent parse speed
527
- - **Build-time optimization**: When importing YAML files, parsing happens at build time, resulting in zero runtime overhead
528
- - **Memory efficient**: Streaming parser design minimizes memory usage
529
- - **Hot reload support**: changes to YAML files trigger instant reloads without server restarts when used with `bun --hot` or Bun's [frontend dev server](/docs/bundler/fullstack)
530
- - **Error recovery**: Detailed error messages with line and column information
@@ -1,4 +1,4 @@
1
- Bun's fast native bundler is now in beta. It can be used via the `bun build` CLI command or the `Bun.build()` JavaScript API.
1
+ Bun's fast native bundler can be used via the `bun build` CLI command or the `Bun.build()` JavaScript API.
2
2
 
3
3
  {% codetabs group="a" %}
4
4
 
@@ -1,6 +1,6 @@
1
1
  The Bun bundler implements a set of default loaders out of the box. As a rule of thumb, the bundler and the runtime both support the same set of file types out of the box.
2
2
 
3
- `.js` `.cjs` `.mjs` `.mts` `.cts` `.ts` `.tsx` `.jsx` `.toml` `.json` `.txt` `.wasm` `.node` `.html`
3
+ `.js` `.cjs` `.mjs` `.mts` `.cts` `.ts` `.tsx` `.jsx` `.toml` `.json` `.yaml` `.yml` `.txt` `.wasm` `.node` `.html`
4
4
 
5
5
  Bun uses the file extension to determine which built-in _loader_ should be used to parse the file. Every loader has a name, such as `js`, `tsx`, or `json`. These names are used when building [plugins](https://bun.com/docs/bundler/plugins) that extend Bun with custom loaders.
6
6
 
@@ -121,6 +121,55 @@ export default {
121
121
 
122
122
  {% /codetabs %}
123
123
 
124
+ ### `yaml`
125
+
126
+ **YAML loader**. Default for `.yaml` and `.yml`.
127
+
128
+ YAML files can be directly imported. Bun will parse them with its fast native YAML parser.
129
+
130
+ ```ts
131
+ import config from "./config.yaml";
132
+ config.database.host; // => "localhost"
133
+
134
+ // via import attribute:
135
+ // import myCustomYAML from './my.config' with {type: "yaml"};
136
+ ```
137
+
138
+ During bundling, the parsed YAML is inlined into the bundle as a JavaScript object.
139
+
140
+ ```ts
141
+ var config = {
142
+ database: {
143
+ host: "localhost",
144
+ port: 5432,
145
+ },
146
+ // ...other fields
147
+ };
148
+ config.database.host;
149
+ ```
150
+
151
+ If a `.yaml` or `.yml` file is passed as an entrypoint, it will be converted to a `.js` module that `export default`s the parsed object.
152
+
153
+ {% codetabs %}
154
+
155
+ ```yaml#Input
156
+ name: John Doe
157
+ age: 35
158
+ email: johndoe@example.com
159
+ ```
160
+
161
+ ```js#Output
162
+ export default {
163
+ name: "John Doe",
164
+ age: 35,
165
+ email: "johndoe@example.com"
166
+ }
167
+ ```
168
+
169
+ {% /codetabs %}
170
+
171
+ For more details on YAML support including the runtime API `Bun.YAML.parse()`, see the [YAML API documentation](/docs/api/yaml).
172
+
124
173
  ### `text`
125
174
 
126
175
  **Text loader**. Default for `.txt`.
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.21-canary.20250823T140535 (ca7428e9)
216
+ bun pm version v1.2.21-canary.20250824T140615 (ca7428e9)
217
217
  Current package version: v1.0.0
218
218
 
219
219
  Increment:
@@ -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.21-canary.20250823T140535 (ca7428e9)
10
+ bun publish v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (16b4bf34)
12
+ bun install v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535"
18
+ + "@types/bun": "^1.2.21-canary.20250824T140615"
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.21-canary.20250823T140535"
30
+ "@types/bun": "^1.2.21-canary.20250824T140615"
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.21-canary.20250823T140535
100
+ $ bun update @types/bun@1.2.21-canary.20250824T140615
101
101
 
102
102
  # Update all dependencies to the latest versions
103
103
  $ bun update --latest
@@ -0,0 +1,76 @@
1
+ ---
2
+ name: Import a YAML file
3
+ ---
4
+
5
+ Bun natively supports `.yaml` and `.yml` imports.
6
+
7
+ ```yaml#config.yaml
8
+ database:
9
+ host: localhost
10
+ port: 5432
11
+ name: myapp
12
+
13
+ server:
14
+ port: 3000
15
+ timeout: 30
16
+
17
+ features:
18
+ auth: true
19
+ rateLimit: true
20
+ ```
21
+
22
+ ---
23
+
24
+ Import the file like any other source file.
25
+
26
+ ```ts
27
+ import config from "./config.yaml";
28
+
29
+ config.database.host; // => "localhost"
30
+ config.server.port; // => 3000
31
+ config.features.auth; // => true
32
+ ```
33
+
34
+ ---
35
+
36
+ You can also use named imports to destructure top-level properties:
37
+
38
+ ```ts
39
+ import { database, server, features } from "./config.yaml";
40
+
41
+ console.log(database.name); // => "myapp"
42
+ console.log(server.timeout); // => 30
43
+ console.log(features.rateLimit); // => true
44
+ ```
45
+
46
+ ---
47
+
48
+ Bun also supports [Import Attributes](https://github.com/tc39/proposal-import-attributes) syntax:
49
+
50
+ ```ts
51
+ import config from "./config.yaml" with { type: "yaml" };
52
+
53
+ config.database.port; // => 5432
54
+ ```
55
+
56
+ ---
57
+
58
+ For parsing YAML strings at runtime, use `Bun.YAML.parse()`:
59
+
60
+ ```ts
61
+ const yamlString = `
62
+ name: John Doe
63
+ age: 30
64
+ hobbies:
65
+ - reading
66
+ - coding
67
+ `;
68
+
69
+ const data = Bun.YAML.parse(yamlString);
70
+ console.log(data.name); // => "John Doe"
71
+ console.log(data.hobbies); // => ["reading", "coding"]
72
+ ```
73
+
74
+ ---
75
+
76
+ See [Docs > API > YAML](https://bun.com/docs/api/yaml) for complete documentation on YAML support in Bun.
@@ -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.21-canary.20250823T140535 (9c68abdb)
24
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
50
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
88
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
21
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
64
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
81
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535 (9c68abdb)
32
+ bun test v1.2.21-canary.20250824T140615 (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.21-canary.20250823T140535"
8
+ Bun.version; // => "1.2.21-canary.20250824T140615"
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.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.21-canary.20250823T140535"
17
+ $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.20250824T140615"
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.21-canary.20250823T140535`.
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.21-canary.20250824T140615`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.20250823T140535"
195
+ $ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.20250824T140615"
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.21-canary.20250823T140535"
204
+ $ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.21-canary.20250824T140615"
205
205
  ```
206
206
 
207
207
  ## Downloading Bun binaries directly
@@ -195,7 +195,7 @@ Click the link in the right column to jump to the associated documentation.
195
195
  ---
196
196
 
197
197
  - Parsing & Formatting
198
- - [`Bun.semver`](https://bun.com/docs/api/semver), `Bun.TOML.parse`, [`Bun.color`](https://bun.com/docs/api/color)
198
+ - [`Bun.semver`](https://bun.com/docs/api/semver), `Bun.TOML.parse`, [`Bun.YAML.parse`](https://bun.com/docs/api/yaml), [`Bun.color`](https://bun.com/docs/api/color)
199
199
 
200
200
  ---
201
201
 
@@ -94,6 +94,7 @@ Bun supports the following loaders:
94
94
  - `file`
95
95
  - `json`
96
96
  - `toml`
97
+ - `yaml`
97
98
  - `wasm`
98
99
  - `napi`
99
100
  - `base64`
@@ -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.21-canary.20250823T140535" -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.21-canary.20250824T140615" -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.21-canary.20250823T140535
131
+ [fetch] > User-Agent: Bun/1.2.21-canary.20250824T140615
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.21-canary.20250823T140535
173
+ [fetch] > User-Agent: Bun/1.2.21-canary.20250824T140615
174
174
  [fetch] > Accept: */*
175
175
  [fetch] > Host: example.com
176
176
  [fetch] > Accept-Encoding: gzip, deflate, br
@@ -92,15 +92,18 @@ every file before execution. Its transpiler can directly run TypeScript and JSX
92
92
 
93
93
  ## JSX
94
94
 
95
- ## JSON and TOML
95
+ ## JSON, TOML, and YAML
96
96
 
97
- Source files can import a `*.json` or `*.toml` file to load its contents as a plain old JavaScript object.
97
+ Source files can import `*.json`, `*.toml`, or `*.yaml` files to load their contents as plain JavaScript objects.
98
98
 
99
99
  ```ts
100
100
  import pkg from "./package.json";
101
101
  import bunfig from "./bunfig.toml";
102
+ import config from "./config.yaml";
102
103
  ```
103
104
 
105
+ See the [YAML API documentation](/docs/api/yaml) for more details on YAML support.
106
+
104
107
  ## WASI
105
108
 
106
109
  {% callout %}
@@ -52,15 +52,18 @@ Hello world!
52
52
 
53
53
  {% /codetabs %}
54
54
 
55
- ## JSON and TOML
55
+ ## JSON, TOML, and YAML
56
56
 
57
- JSON and TOML files can be directly imported from a source file. The contents will be loaded and returned as a JavaScript object.
57
+ JSON, TOML, and YAML files can be directly imported from a source file. The contents will be loaded and returned as a JavaScript object.
58
58
 
59
59
  ```ts
60
60
  import pkg from "./package.json";
61
61
  import data from "./data.toml";
62
+ import config from "./config.yaml";
62
63
  ```
63
64
 
65
+ For more details on YAML support, see the [YAML API documentation](/docs/api/yaml).
66
+
64
67
  ## WASI
65
68
 
66
69
  {% callout %}
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.21-canary.20250823T140535
58
+ bun test v1.2.21-canary.20250824T140615
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.21-canary.20250823T140535",
2
+ "version": "1.2.21-canary.20250824T140615",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",