bun-types 1.2.3-canary.20250206T140614 → 1.2.3-canary.20250208T140533
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 +40 -21
- package/docs/api/fetch.md +1 -1
- package/docs/api/spawn.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/bun.d.ts
CHANGED
|
@@ -2051,35 +2051,51 @@ declare module "bun" {
|
|
|
2051
2051
|
*/
|
|
2052
2052
|
type SQLOptions = {
|
|
2053
2053
|
/** Connection URL (can be string or URL object) */
|
|
2054
|
-
url
|
|
2054
|
+
url?: URL | string;
|
|
2055
2055
|
/** Database server hostname */
|
|
2056
|
-
host
|
|
2056
|
+
host?: string;
|
|
2057
|
+
/** Database server hostname (alias for host) */
|
|
2058
|
+
hostname?: string;
|
|
2057
2059
|
/** Database server port number */
|
|
2058
|
-
port
|
|
2060
|
+
port?: number | string;
|
|
2059
2061
|
/** Database user for authentication */
|
|
2060
|
-
username
|
|
2062
|
+
username?: string;
|
|
2063
|
+
/** Database user for authentication (alias for username) */
|
|
2064
|
+
user?: string;
|
|
2061
2065
|
/** Database password for authentication */
|
|
2062
|
-
password
|
|
2066
|
+
password?: string;
|
|
2067
|
+
/** Database password for authentication (alias for password) */
|
|
2068
|
+
pass?: string;
|
|
2063
2069
|
/** Name of the database to connect to */
|
|
2064
|
-
database
|
|
2070
|
+
database?: string;
|
|
2071
|
+
/** Name of the database to connect to (alias for database) */
|
|
2072
|
+
db?: string;
|
|
2065
2073
|
/** Database adapter/driver to use */
|
|
2066
|
-
adapter
|
|
2067
|
-
/** Maximum time in
|
|
2068
|
-
idleTimeout
|
|
2069
|
-
/** Maximum time in
|
|
2070
|
-
|
|
2071
|
-
/** Maximum
|
|
2072
|
-
|
|
2074
|
+
adapter?: string;
|
|
2075
|
+
/** Maximum time in seconds to wait for connection to become available */
|
|
2076
|
+
idleTimeout?: number;
|
|
2077
|
+
/** Maximum time in seconds to wait for connection to become available (alias for idleTimeout) */
|
|
2078
|
+
idle_timeout?: number;
|
|
2079
|
+
/** Maximum time in seconds to wait when establishing a connection */
|
|
2080
|
+
connectionTimeout?: number;
|
|
2081
|
+
/** Maximum time in seconds to wait when establishing a connection (alias for connectionTimeout) */
|
|
2082
|
+
connection_timeout?: number;
|
|
2083
|
+
/** Maximum lifetime in seconds of a connection */
|
|
2084
|
+
maxLifetime?: number;
|
|
2085
|
+
/** Maximum lifetime in seconds of a connection (alias for maxLifetime) */
|
|
2086
|
+
max_lifetime?: number;
|
|
2073
2087
|
/** Whether to use TLS/SSL for the connection */
|
|
2074
|
-
tls
|
|
2088
|
+
tls?: TLSOptions | boolean;
|
|
2089
|
+
/** Whether to use TLS/SSL for the connection (alias for tls) */
|
|
2090
|
+
ssl?: TLSOptions | boolean;
|
|
2075
2091
|
/** Callback function executed when a connection is established */
|
|
2076
|
-
onconnect
|
|
2092
|
+
onconnect?: (client: SQL) => void;
|
|
2077
2093
|
/** Callback function executed when a connection is closed */
|
|
2078
|
-
onclose
|
|
2094
|
+
onclose?: (client: SQL) => void;
|
|
2079
2095
|
/** Maximum number of connections in the pool */
|
|
2080
|
-
max
|
|
2096
|
+
max?: number;
|
|
2081
2097
|
/** By default values outside i32 range are returned as strings. If this is true, values outside i32 range are returned as BigInts. */
|
|
2082
|
-
bigint
|
|
2098
|
+
bigint?: boolean;
|
|
2083
2099
|
};
|
|
2084
2100
|
|
|
2085
2101
|
/**
|
|
@@ -5519,7 +5535,10 @@ declare module "bun" {
|
|
|
5519
5535
|
|
|
5520
5536
|
interface PluginBuilder {
|
|
5521
5537
|
/**
|
|
5522
|
-
* Register a callback which will be invoked when bundling starts.
|
|
5538
|
+
* Register a callback which will be invoked when bundling starts. When
|
|
5539
|
+
* using hot module reloading, this is called at the start of each
|
|
5540
|
+
* incremental rebuild.
|
|
5541
|
+
*
|
|
5523
5542
|
* @example
|
|
5524
5543
|
* ```ts
|
|
5525
5544
|
* Bun.plugin({
|
|
@@ -5626,9 +5645,9 @@ declare module "bun" {
|
|
|
5626
5645
|
* - `browser`: The plugin will be applied to browser builds
|
|
5627
5646
|
* - `node`: The plugin will be applied to Node.js builds
|
|
5628
5647
|
*
|
|
5629
|
-
* If
|
|
5648
|
+
* If unspecified, it is assumed that the plugin is compatible with all targets.
|
|
5630
5649
|
*
|
|
5631
|
-
*
|
|
5650
|
+
* This field is not read by Bun.plugin
|
|
5632
5651
|
*/
|
|
5633
5652
|
target?: Target;
|
|
5634
5653
|
/**
|
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.3-canary.
|
|
340
|
+
[fetch] > User-Agent: Bun/1.2.3-canary.20250208T140533
|
|
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.3-canary.
|
|
113
|
+
console.log(text); // => "1.2.3-canary.20250208T140533"
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
Configure the output stream by passing one of the following values to `stdout/stderr`:
|
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.3-canary.
|
|
12
|
+
bun install v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
19
|
+
+ "@types/bun": "^1.2.3-canary.20250208T140533"
|
|
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.3-canary.
|
|
31
|
+
"@types/bun": "^1.2.3-canary.20250208T140533"
|
|
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.3-canary.
|
|
100
|
+
$ bun update @types/bun@1.2.3-canary.20250208T140533
|
|
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.3-canary.
|
|
24
|
+
bun test v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
50
|
+
bun test v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
88
|
+
bun test v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
21
|
+
bun test v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
64
|
+
bun test v1.2.3-canary.20250208T140533 (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.3-canary.
|
|
81
|
+
bun test v1.2.3-canary.20250208T140533 (9c68abdb)
|
|
82
82
|
|
|
83
83
|
test/snap.test.ts:
|
|
84
84
|
✓ 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.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.3-canary.
|
|
17
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250208T140533"
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
```bash#npm
|
|
@@ -166,10 +166,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
|
|
|
166
166
|
|
|
167
167
|
### Installing a specific version of Bun on Linux/Mac
|
|
168
168
|
|
|
169
|
-
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.3-canary.
|
|
169
|
+
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.3-canary.20250208T140533`.
|
|
170
170
|
|
|
171
171
|
```sh
|
|
172
|
-
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.
|
|
172
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250208T140533"
|
|
173
173
|
```
|
|
174
174
|
|
|
175
175
|
### Installing a specific version of Bun on Windows
|
|
@@ -178,7 +178,7 @@ On Windows, you can install a specific version of Bun by passing the version num
|
|
|
178
178
|
|
|
179
179
|
```sh
|
|
180
180
|
# PowerShell:
|
|
181
|
-
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.
|
|
181
|
+
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.20250208T140533"
|
|
182
182
|
```
|
|
183
183
|
|
|
184
184
|
## 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.3-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.3-canary.20250208T140533" -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.3-canary.
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.3-canary.20250208T140533
|
|
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.3-canary.
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.3-canary.20250208T140533
|
|
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