bun-types 1.2.20-canary.20250731T140826 → 1.2.20-canary.20250801T140826
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 +1 -1
- package/docs/api/http.md +64 -0
- package/docs/api/spawn.md +1 -1
- package/docs/cli/pm.md +1 -1
- 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/installation.md +4 -4
- package/docs/runtime/debugger.md +3 -3
- package/docs/test/dom.md +1 -1
- package/package.json +1 -1
- package/sqlite.d.ts +16 -7
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.20-canary.
|
|
340
|
+
[fetch] > User-Agent: Bun/1.2.20-canary.20250801T140826
|
|
341
341
|
[fetch] > Accept: */*
|
|
342
342
|
[fetch] > Host: example.com
|
|
343
343
|
[fetch] > Accept-Encoding: gzip, deflate, br
|
package/docs/api/http.md
CHANGED
|
@@ -164,6 +164,70 @@ Static responses do not allocate additional memory after initialization. You can
|
|
|
164
164
|
|
|
165
165
|
Static route responses are cached for the lifetime of the server object. To reload static routes, call `server.reload(options)`.
|
|
166
166
|
|
|
167
|
+
### File Responses vs Static Responses
|
|
168
|
+
|
|
169
|
+
When serving files in routes, there are two distinct behaviors depending on whether you buffer the file content or serve it directly:
|
|
170
|
+
|
|
171
|
+
```ts
|
|
172
|
+
Bun.serve({
|
|
173
|
+
routes: {
|
|
174
|
+
// Static route - content is buffered in memory at startup
|
|
175
|
+
"/logo.png": new Response(await Bun.file("./logo.png").bytes()),
|
|
176
|
+
|
|
177
|
+
// File route - content is read from filesystem on each request
|
|
178
|
+
"/download.zip": new Response(Bun.file("./download.zip")),
|
|
179
|
+
},
|
|
180
|
+
});
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
**Static routes** (`new Response(await file.bytes())`) buffer content in memory at startup:
|
|
184
|
+
|
|
185
|
+
- **Zero filesystem I/O** during requests - content served entirely from memory
|
|
186
|
+
- **ETag support** - Automatically generates and validates ETags for caching
|
|
187
|
+
- **If-None-Match** - Returns `304 Not Modified` when client ETag matches
|
|
188
|
+
- **No 404 handling** - Missing files cause startup errors, not runtime 404s
|
|
189
|
+
- **Memory usage** - Full file content stored in RAM
|
|
190
|
+
- **Best for**: Small static assets, API responses, frequently accessed files
|
|
191
|
+
|
|
192
|
+
**File routes** (`new Response(Bun.file(path))`) read from filesystem per request:
|
|
193
|
+
|
|
194
|
+
- **Filesystem reads** on each request - checks file existence and reads content
|
|
195
|
+
- **Built-in 404 handling** - Returns `404 Not Found` if file doesn't exist or becomes inaccessible
|
|
196
|
+
- **Last-Modified support** - Uses file modification time for `If-Modified-Since` headers
|
|
197
|
+
- **If-Modified-Since** - Returns `304 Not Modified` when file hasn't changed since client's cached version
|
|
198
|
+
- **Range request support** - Automatically handles partial content requests with `Content-Range` headers
|
|
199
|
+
- **Streaming transfers** - Uses buffered reader with backpressure handling for efficient memory usage
|
|
200
|
+
- **Memory efficient** - Only buffers small chunks during transfer, not entire file
|
|
201
|
+
- **Best for**: Large files, dynamic content, user uploads, files that change frequently
|
|
202
|
+
|
|
203
|
+
### HTTP Caching Behavior
|
|
204
|
+
|
|
205
|
+
Both route types implement HTTP caching standards but with different strategies:
|
|
206
|
+
|
|
207
|
+
#### Static Routes Caching
|
|
208
|
+
|
|
209
|
+
- **ETag generation**: Automatically computes ETag hash from content at startup
|
|
210
|
+
- **If-None-Match**: Validates client ETag against server ETag
|
|
211
|
+
- **304 responses**: Returns `304 Not Modified` with empty body when ETags match
|
|
212
|
+
- **Cache headers**: Inherits any `Cache-Control` headers you provide in the Response
|
|
213
|
+
- **Consistency**: ETag remains constant until server restart or route reload
|
|
214
|
+
|
|
215
|
+
#### File Routes Caching
|
|
216
|
+
|
|
217
|
+
- **Last-Modified**: Uses file's `mtime` for `Last-Modified` header
|
|
218
|
+
- **If-Modified-Since**: Compares client date with file modification time
|
|
219
|
+
- **304 responses**: Returns `304 Not Modified` when file unchanged since client's cached version
|
|
220
|
+
- **Content-Length**: Automatically set based on current file size
|
|
221
|
+
- **Dynamic validation**: Checks file modification time on each request
|
|
222
|
+
|
|
223
|
+
#### Status Code Handling
|
|
224
|
+
|
|
225
|
+
Both route types automatically adjust status codes:
|
|
226
|
+
|
|
227
|
+
- **200 → 204**: Empty files (0 bytes) return `204 No Content` instead of `200 OK`
|
|
228
|
+
- **200 → 304**: Successful cache validation returns `304 Not Modified`
|
|
229
|
+
- **File routes only**: Missing or inaccessible files return `404 Not Found`
|
|
230
|
+
|
|
167
231
|
```ts
|
|
168
232
|
const server = Bun.serve({
|
|
169
233
|
static: {
|
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.20-canary.
|
|
143
|
+
console.log(text); // => "1.2.20-canary.20250801T140826\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.20-canary.
|
|
216
|
+
bun pm version v1.2.20-canary.20250801T140826 (ca7428e9)
|
|
217
217
|
Current package version: v1.0.0
|
|
218
218
|
|
|
219
219
|
Increment:
|
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.20-canary.
|
|
12
|
+
bun install v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
18
|
+
+ "@types/bun": "^1.2.20-canary.20250801T140826"
|
|
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.20-canary.
|
|
30
|
+
"@types/bun": "^1.2.20-canary.20250801T140826"
|
|
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.20-canary.
|
|
100
|
+
$ bun update @types/bun@1.2.20-canary.20250801T140826
|
|
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.20-canary.
|
|
24
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
50
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
88
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
21
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
64
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
81
|
+
bun test v1.2.20-canary.20250801T140826 (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.20-canary.
|
|
32
|
+
bun test v1.2.20-canary.20250801T140826 (9c68abdb)
|
|
33
33
|
|
|
34
34
|
test/snap.test.ts:
|
|
35
35
|
✓ snapshot [0.86ms]
|
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.20-canary.
|
|
17
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.20-canary.20250801T140826"
|
|
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.20-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.20-canary.20250801T140826`.
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
|
-
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.20-canary.
|
|
195
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.20-canary.20250801T140826"
|
|
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.20-canary.
|
|
204
|
+
$ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.20-canary.20250801T140826"
|
|
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.20-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.20-canary.20250801T140826" -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.20-canary.
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.20-canary.20250801T140826
|
|
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.20-canary.
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.20-canary.20250801T140826
|
|
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
package/sqlite.d.ts
CHANGED
|
@@ -383,19 +383,28 @@ declare module "bun:sqlite" {
|
|
|
383
383
|
* ]);
|
|
384
384
|
* ```
|
|
385
385
|
*/
|
|
386
|
-
transaction
|
|
386
|
+
transaction<A extends any[], T>(
|
|
387
|
+
insideTransaction: (...args: A) => T,
|
|
388
|
+
): {
|
|
387
389
|
/**
|
|
388
|
-
*
|
|
390
|
+
* Execute the transaction
|
|
389
391
|
*/
|
|
390
|
-
|
|
392
|
+
(...args: A): T;
|
|
393
|
+
|
|
391
394
|
/**
|
|
392
|
-
*
|
|
395
|
+
* Execute the transaction using "BEGIN DEFERRED"
|
|
393
396
|
*/
|
|
394
|
-
|
|
397
|
+
deferred: (...args: A) => T;
|
|
398
|
+
|
|
399
|
+
/**
|
|
400
|
+
* Execute the transaction using "BEGIN IMMEDIATE"
|
|
401
|
+
*/
|
|
402
|
+
immediate: (...args: A) => T;
|
|
403
|
+
|
|
395
404
|
/**
|
|
396
|
-
*
|
|
405
|
+
* Execute the transaction using "BEGIN EXCLUSIVE"
|
|
397
406
|
*/
|
|
398
|
-
exclusive: (...args:
|
|
407
|
+
exclusive: (...args: A) => T;
|
|
399
408
|
};
|
|
400
409
|
|
|
401
410
|
/**
|