bun-types 1.2.5-canary.20250304T140606 → 1.2.5-canary.20250306T140602

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 CHANGED
@@ -2692,9 +2692,15 @@ declare module "bun" {
2692
2692
  kind: ImportKind;
2693
2693
  }
2694
2694
 
2695
+ /**
2696
+ * @see [Bun.build API docs](https://bun.sh/docs/bundler#api)
2697
+ */
2695
2698
  interface BuildConfig {
2696
2699
  entrypoints: string[]; // list of file path
2697
2700
  outdir?: string; // output directory
2701
+ /**
2702
+ * @default "browser"
2703
+ */
2698
2704
  target?: Target; // default: "browser"
2699
2705
  /**
2700
2706
  * Output module format. Top-level await is only supported for `"esm"`.
@@ -2738,7 +2744,25 @@ declare module "bun" {
2738
2744
  define?: Record<string, string>;
2739
2745
  // origin?: string; // e.g. http://mydomain.com
2740
2746
  loader?: { [k in string]: Loader };
2741
- sourcemap?: "none" | "linked" | "inline" | "external" | "linked" | boolean; // default: "none", true -> "inline"
2747
+ /**
2748
+ * Specifies if and how to generate source maps.
2749
+ *
2750
+ * - `"none"` - No source maps are generated
2751
+ * - `"linked"` - A separate `*.ext.map` file is generated alongside each
2752
+ * `*.ext` file. A `//# sourceMappingURL` comment is added to the output
2753
+ * file to link the two. Requires `outdir` to be set.
2754
+ * - `"inline"` - an inline source map is appended to the output file.
2755
+ * - `"external"` - Generate a separate source map file for each input file.
2756
+ * No `//# sourceMappingURL` comment is added to the output file.
2757
+ *
2758
+ * `true` and `false` are aliasees for `"inline"` and `"none"`, respectively.
2759
+ *
2760
+ * @default "none"
2761
+ *
2762
+ * @see {@link outdir} required for `"linked"` maps
2763
+ * @see {@link publicPath} to customize the base url of linked source maps
2764
+ */
2765
+ sourcemap?: "none" | "linked" | "inline" | "external" | "linked" | boolean;
2742
2766
  /**
2743
2767
  * package.json `exports` conditions used when resolving imports
2744
2768
  *
@@ -2767,6 +2791,14 @@ declare module "bun" {
2767
2791
  * ```
2768
2792
  */
2769
2793
  env?: "inline" | "disable" | `${string}*`;
2794
+ /**
2795
+ * Whether to enable minification.
2796
+ *
2797
+ * Use `true`/`false` to enable/disable all minification options. Alternatively,
2798
+ * you can pass an object for granular control over certain minifications.
2799
+ *
2800
+ * @default false
2801
+ */
2770
2802
  minify?:
2771
2803
  | boolean
2772
2804
  | {
@@ -6031,13 +6063,15 @@ declare module "bun" {
6031
6063
  *
6032
6064
  * If unspecified, it is assumed that the plugin is compatible with all targets.
6033
6065
  *
6034
- * This field is not read by Bun.plugin
6066
+ * This field is not read by {@link Bun.plugin}
6035
6067
  */
6036
6068
  target?: Target;
6037
6069
  /**
6038
6070
  * A function that will be called when the plugin is loaded.
6039
6071
  *
6040
- * This function may be called in the same tick that it is registered, or it may be called later. It could potentially be called multiple times for different targets.
6072
+ * This function may be called in the same tick that it is registered, or it
6073
+ * may be called later. It could potentially be called multiple times for
6074
+ * different targets.
6041
6075
  */
6042
6076
  setup(
6043
6077
  /**
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.5-canary.20250304T140606
340
+ [fetch] > User-Agent: Bun/1.2.5-canary.20250306T140602
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.5-canary.20250304T140606"
113
+ console.log(text); // => "1.2.5-canary.20250306T140602"
114
114
  ```
115
115
 
116
116
  Configure the output stream by passing one of the following values to `stdout/stderr`:
@@ -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.5-canary.20250304T140606 (ca7428e9)
10
+ bun publish v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (16b4bf34)
12
+ bun install v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606"
19
+ + "@types/bun": "^1.2.5-canary.20250306T140602"
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.5-canary.20250304T140606"
31
+ "@types/bun": "^1.2.5-canary.20250306T140602"
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.5-canary.20250304T140606
100
+ $ bun update @types/bun@1.2.5-canary.20250306T140602
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.5-canary.20250304T140606 (9c68abdb)
24
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
50
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
88
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
21
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
64
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
81
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606 (9c68abdb)
32
+ bun test v1.2.5-canary.20250306T140602 (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.5-canary.20250304T140606"
8
+ Bun.version; // => "1.2.5-canary.20250306T140602"
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.5-canary.20250304T140606"
17
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5-canary.20250306T140602"
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.5-canary.20250304T140606`.
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.5-canary.20250306T140602`.
193
193
 
194
194
  ```sh
195
- $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5-canary.20250304T140606"
195
+ $ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5-canary.20250306T140602"
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.5-canary.20250304T140606"
204
+ $ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.5-canary.20250306T140602"
205
205
  ```
206
206
 
207
207
  ## 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.5-canary.20250304T140606" -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.5-canary.20250306T140602" -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.5-canary.20250304T140606
131
+ [fetch] > User-Agent: Bun/1.2.5-canary.20250306T140602
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.5-canary.20250304T140606
173
+ [fetch] > User-Agent: Bun/1.2.5-canary.20250306T140602
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.5-canary.20250304T140606
58
+ bun test v1.2.5-canary.20250306T140602
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.5-canary.20250304T140606",
2
+ "version": "1.2.5-canary.20250306T140602",
3
3
  "name": "bun-types",
4
4
  "license": "MIT",
5
5
  "types": "./index.d.ts",