bun-types 1.2.5-canary.20250309T140515 → 1.2.5
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 +64 -0
- 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/globals.d.ts +27 -1
- package/package.json +1 -1
package/bun.d.ts
CHANGED
|
@@ -2361,10 +2361,74 @@ declare module "bun" {
|
|
|
2361
2361
|
*/
|
|
2362
2362
|
interface SavepointSQL extends SQL {}
|
|
2363
2363
|
|
|
2364
|
+
type CSRFAlgorithm =
|
|
2365
|
+
| "blake2b256"
|
|
2366
|
+
| "blake2b512"
|
|
2367
|
+
| "sha256"
|
|
2368
|
+
| "sha384"
|
|
2369
|
+
| "sha512"
|
|
2370
|
+
| "sha512-256";
|
|
2371
|
+
interface CSRFGenerateOptions {
|
|
2372
|
+
/**
|
|
2373
|
+
* The number of milliseconds until the token expires. 0 means the token never expires.
|
|
2374
|
+
* @default 24 * 60 * 60 * 1000 (24 hours)
|
|
2375
|
+
*/
|
|
2376
|
+
expiresIn?: number;
|
|
2377
|
+
/**
|
|
2378
|
+
* The encoding of the token.
|
|
2379
|
+
* @default "base64url"
|
|
2380
|
+
*/
|
|
2381
|
+
encoding?: "base64" | "base64url" | "hex";
|
|
2382
|
+
/**
|
|
2383
|
+
* The algorithm to use for the token.
|
|
2384
|
+
* @default "sha256"
|
|
2385
|
+
*/
|
|
2386
|
+
algorithm?: CSRFAlgorithm;
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
interface CSRFVerifyOptions {
|
|
2390
|
+
/**
|
|
2391
|
+
* The secret to use for the token. If not provided, a random default secret will be generated in memory and used.
|
|
2392
|
+
*/
|
|
2393
|
+
secret?: string;
|
|
2394
|
+
/**
|
|
2395
|
+
* The encoding of the token.
|
|
2396
|
+
* @default "base64url"
|
|
2397
|
+
*/
|
|
2398
|
+
encoding?: "base64" | "base64url" | "hex";
|
|
2399
|
+
/**
|
|
2400
|
+
* The algorithm to use for the token.
|
|
2401
|
+
* @default "sha256"
|
|
2402
|
+
*/
|
|
2403
|
+
algorithm?: CSRFAlgorithm;
|
|
2404
|
+
/**
|
|
2405
|
+
* The number of milliseconds until the token expires. 0 means the token never expires.
|
|
2406
|
+
* @default 24 * 60 * 60 * 1000 (24 hours)
|
|
2407
|
+
*/
|
|
2408
|
+
maxAge?: number;
|
|
2409
|
+
}
|
|
2410
|
+
interface CSRF {
|
|
2411
|
+
/**
|
|
2412
|
+
* Generate a CSRF token.
|
|
2413
|
+
* @param secret The secret to use for the token. If not provided, a random default secret will be generated in memory and used.
|
|
2414
|
+
* @param options The options for the token.
|
|
2415
|
+
* @returns The generated token.
|
|
2416
|
+
*/
|
|
2417
|
+
generate(secret?: string, options?: CSRFGenerateOptions): string;
|
|
2418
|
+
/**
|
|
2419
|
+
* Verify a CSRF token.
|
|
2420
|
+
* @param token The token to verify.
|
|
2421
|
+
* @param options The options for the token.
|
|
2422
|
+
* @returns True if the token is valid, false otherwise.
|
|
2423
|
+
*/
|
|
2424
|
+
verify(token: string, options?: CSRFVerifyOptions): boolean;
|
|
2425
|
+
}
|
|
2426
|
+
|
|
2364
2427
|
var sql: SQL;
|
|
2365
2428
|
var postgres: SQL;
|
|
2366
2429
|
var SQL: SQL;
|
|
2367
2430
|
|
|
2431
|
+
var CSRF: CSRF;
|
|
2368
2432
|
/**
|
|
2369
2433
|
* This lets you use macros as regular imports
|
|
2370
2434
|
* @example
|
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
|
|
340
|
+
[fetch] > User-Agent: Bun/1.2.5
|
|
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
|
|
113
|
+
console.log(text); // => "1.2.5"
|
|
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.5
|
|
12
|
+
bun install v1.2.5 (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
|
|
19
|
+
+ "@types/bun": "^1.2.5"
|
|
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
|
|
31
|
+
"@types/bun": "^1.2.5"
|
|
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
|
|
100
|
+
$ bun update @types/bun@1.2.5
|
|
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
|
|
24
|
+
bun test v1.2.5 (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
|
|
50
|
+
bun test v1.2.5 (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
|
|
88
|
+
bun test v1.2.5 (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
|
|
21
|
+
bun test v1.2.5 (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
|
|
64
|
+
bun test v1.2.5 (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
|
|
81
|
+
bun test v1.2.5 (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.5
|
|
17
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5"
|
|
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
|
|
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`.
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
|
-
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5
|
|
195
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.5"
|
|
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
|
|
204
|
+
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.5"
|
|
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.5
|
|
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" -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
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.5
|
|
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
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.5
|
|
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/globals.d.ts
CHANGED
|
@@ -1870,6 +1870,32 @@ declare global {
|
|
|
1870
1870
|
*/
|
|
1871
1871
|
bytes(): Promise<Uint8Array>;
|
|
1872
1872
|
}
|
|
1873
|
-
|
|
1874
1873
|
var Blob: typeof Blob;
|
|
1874
|
+
|
|
1875
|
+
interface Uint8Array {
|
|
1876
|
+
/**
|
|
1877
|
+
* Convert the Uint8Array to a base64 encoded string
|
|
1878
|
+
* @returns The base64 encoded string representation of the Uint8Array
|
|
1879
|
+
*/
|
|
1880
|
+
toBase64(options?: {
|
|
1881
|
+
alphabet?: "base64" | "base64url";
|
|
1882
|
+
omitPadding?: boolean;
|
|
1883
|
+
}): string;
|
|
1884
|
+
|
|
1885
|
+
/**
|
|
1886
|
+
* Set the contents of the Uint8Array from a base64 encoded string
|
|
1887
|
+
* @param base64 The base64 encoded string to decode into the array
|
|
1888
|
+
* @param offset Optional starting index to begin setting the decoded bytes (default: 0)
|
|
1889
|
+
*/
|
|
1890
|
+
setFromBase64(base64: string, offset?: number): void;
|
|
1891
|
+
}
|
|
1892
|
+
|
|
1893
|
+
interface Uint8ArrayConstructor {
|
|
1894
|
+
/**
|
|
1895
|
+
* Create a new Uint8Array from a base64 encoded string
|
|
1896
|
+
* @param base64 The base64 encoded string to convert to a Uint8Array
|
|
1897
|
+
* @returns A new Uint8Array containing the decoded data
|
|
1898
|
+
*/
|
|
1899
|
+
fromBase64(base64: string): Uint8Array;
|
|
1900
|
+
}
|
|
1875
1901
|
}
|
package/package.json
CHANGED