bun-types 1.2.21-canary.20250815T140623 → 1.2.21-canary.20250817T140525
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/spawn.md +1 -1
- package/docs/api/utils.md +59 -0
- 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/globals.d.ts +19 -0
- package/package.json +1 -1
- package/redis.d.ts +44 -0
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.
|
|
339
|
+
[fetch] > User-Agent: Bun/1.2.21-canary.20250817T140525
|
|
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.
|
|
143
|
+
console.log(text); // => "1.2.21-canary.20250817T140525\n"
|
|
144
144
|
```
|
|
145
145
|
|
|
146
146
|
Configure the output stream by passing one of the following values to `stdout/stderr`:
|
package/docs/api/utils.md
CHANGED
|
@@ -772,6 +772,65 @@ console.log(obj); // => { foo: "bar" }
|
|
|
772
772
|
|
|
773
773
|
Internally, [`structuredClone`](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone) and [`postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) serialize and deserialize the same way. This exposes the underlying [HTML Structured Clone Algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm) to JavaScript as an ArrayBuffer.
|
|
774
774
|
|
|
775
|
+
## `Bun.stripANSI()` ~6-57x faster `strip-ansi` alternative
|
|
776
|
+
|
|
777
|
+
`Bun.stripANSI(text: string): string`
|
|
778
|
+
|
|
779
|
+
Strip ANSI escape codes from a string. This is useful for removing colors and formatting from terminal output.
|
|
780
|
+
|
|
781
|
+
```ts
|
|
782
|
+
const coloredText = "\u001b[31mHello\u001b[0m \u001b[32mWorld\u001b[0m";
|
|
783
|
+
const plainText = Bun.stripANSI(coloredText);
|
|
784
|
+
console.log(plainText); // => "Hello World"
|
|
785
|
+
|
|
786
|
+
// Works with various ANSI codes
|
|
787
|
+
const formatted = "\u001b[1m\u001b[4mBold and underlined\u001b[0m";
|
|
788
|
+
console.log(Bun.stripANSI(formatted)); // => "Bold and underlined"
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
`Bun.stripANSI` is significantly faster than the popular [`strip-ansi`](https://www.npmjs.com/package/strip-ansi) npm package:
|
|
792
|
+
|
|
793
|
+
```js
|
|
794
|
+
> bun bench/snippets/strip-ansi.mjs
|
|
795
|
+
cpu: Apple M3 Max
|
|
796
|
+
runtime: bun 1.2.21 (arm64-darwin)
|
|
797
|
+
|
|
798
|
+
benchmark avg (min … max) p75 / p99
|
|
799
|
+
------------------------------------------------------- ----------
|
|
800
|
+
Bun.stripANSI 11 chars no-ansi 8.13 ns/iter 8.27 ns
|
|
801
|
+
(7.45 ns … 33.59 ns) 10.29 ns
|
|
802
|
+
|
|
803
|
+
Bun.stripANSI 13 chars ansi 51.68 ns/iter 52.51 ns
|
|
804
|
+
(46.16 ns … 113.71 ns) 57.71 ns
|
|
805
|
+
|
|
806
|
+
Bun.stripANSI 16,384 chars long-no-ansi 298.39 ns/iter 305.44 ns
|
|
807
|
+
(281.50 ns … 331.65 ns) 320.70 ns
|
|
808
|
+
|
|
809
|
+
Bun.stripANSI 212,992 chars long-ansi 227.65 µs/iter 234.50 µs
|
|
810
|
+
(216.46 µs … 401.92 µs) 262.25 µs
|
|
811
|
+
```
|
|
812
|
+
|
|
813
|
+
```js
|
|
814
|
+
> node bench/snippets/strip-ansi.mjs
|
|
815
|
+
cpu: Apple M3 Max
|
|
816
|
+
runtime: node 24.6.0 (arm64-darwin)
|
|
817
|
+
|
|
818
|
+
benchmark avg (min … max) p75 / p99
|
|
819
|
+
-------------------------------------------------------- ---------
|
|
820
|
+
npm/strip-ansi 11 chars no-ansi 466.79 ns/iter 468.67 ns
|
|
821
|
+
(454.08 ns … 570.67 ns) 543.67 ns
|
|
822
|
+
|
|
823
|
+
npm/strip-ansi 13 chars ansi 546.77 ns/iter 550.23 ns
|
|
824
|
+
(532.74 ns … 651.08 ns) 590.35 ns
|
|
825
|
+
|
|
826
|
+
npm/strip-ansi 16,384 chars long-no-ansi 4.85 µs/iter 4.89 µs
|
|
827
|
+
(4.71 µs … 5.00 µs) 4.98 µs
|
|
828
|
+
|
|
829
|
+
npm/strip-ansi 212,992 chars long-ansi 1.36 ms/iter 1.38 ms
|
|
830
|
+
(1.27 ms … 1.73 ms) 1.49 ms
|
|
831
|
+
|
|
832
|
+
```
|
|
833
|
+
|
|
775
834
|
## `estimateShallowMemoryUsageOf` in `bun:jsc`
|
|
776
835
|
|
|
777
836
|
The `estimateShallowMemoryUsageOf` function returns a best-effort estimate of the memory usage of an object in bytes, excluding the memory usage of properties or other objects it references. For accurate per-object memory usage, use `Bun.generateHeapSnapshot`.
|
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.
|
|
216
|
+
bun pm version v1.2.21-canary.20250817T140525 (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.21-canary.
|
|
12
|
+
bun install v1.2.21-canary.20250817T140525 (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.
|
|
18
|
+
+ "@types/bun": "^1.2.21-canary.20250817T140525"
|
|
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.
|
|
30
|
+
"@types/bun": "^1.2.21-canary.20250817T140525"
|
|
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.
|
|
100
|
+
$ bun update @types/bun@1.2.21-canary.20250817T140525
|
|
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.21-canary.
|
|
24
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
50
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
88
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
21
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
64
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
81
|
+
bun test v1.2.21-canary.20250817T140525 (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.
|
|
32
|
+
bun test v1.2.21-canary.20250817T140525 (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.21-canary.
|
|
17
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.20250817T140525"
|
|
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.
|
|
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.20250817T140525`.
|
|
193
193
|
|
|
194
194
|
```sh
|
|
195
|
-
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.
|
|
195
|
+
$ curl -fsSL https://bun.com/install | bash -s "bun-v1.2.21-canary.20250817T140525"
|
|
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.
|
|
204
|
+
$ iex "& {$(irm https://bun.com/install.ps1)} -Version 1.2.21-canary.20250817T140525"
|
|
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.21-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.21-canary.20250817T140525" -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.
|
|
131
|
+
[fetch] > User-Agent: Bun/1.2.21-canary.20250817T140525
|
|
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.
|
|
173
|
+
[fetch] > User-Agent: Bun/1.2.21-canary.20250817T140525
|
|
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
|
@@ -1888,6 +1888,25 @@ interface BunFetchRequestInit extends RequestInit {
|
|
|
1888
1888
|
* ```
|
|
1889
1889
|
*/
|
|
1890
1890
|
unix?: string;
|
|
1891
|
+
|
|
1892
|
+
/**
|
|
1893
|
+
* Control automatic decompression of the response body.
|
|
1894
|
+
* When set to `false`, the response body will not be automatically decompressed,
|
|
1895
|
+
* and the `Content-Encoding` header will be preserved. This can improve performance
|
|
1896
|
+
* when you need to handle compressed data manually or forward it as-is.
|
|
1897
|
+
* This is a custom property that is not part of the Fetch API specification.
|
|
1898
|
+
*
|
|
1899
|
+
* @default true
|
|
1900
|
+
* @example
|
|
1901
|
+
* ```js
|
|
1902
|
+
* // Disable automatic decompression for a proxy server
|
|
1903
|
+
* const response = await fetch("https://example.com/api", {
|
|
1904
|
+
* decompress: false
|
|
1905
|
+
* });
|
|
1906
|
+
* // response.headers.get('content-encoding') might be 'gzip' or 'br'
|
|
1907
|
+
* ```
|
|
1908
|
+
*/
|
|
1909
|
+
decompress?: boolean;
|
|
1891
1910
|
}
|
|
1892
1911
|
|
|
1893
1912
|
/**
|
package/package.json
CHANGED
package/redis.d.ts
CHANGED
|
@@ -574,6 +574,50 @@ declare module "bun" {
|
|
|
574
574
|
*/
|
|
575
575
|
getex(key: RedisClient.KeyLike): Promise<string | null>;
|
|
576
576
|
|
|
577
|
+
/**
|
|
578
|
+
* Get the value of a key and set its expiration in seconds
|
|
579
|
+
* @param key The key to get
|
|
580
|
+
* @param ex Set the specified expire time, in seconds
|
|
581
|
+
* @param seconds The number of seconds until expiration
|
|
582
|
+
* @returns Promise that resolves with the value of the key, or null if the key doesn't exist
|
|
583
|
+
*/
|
|
584
|
+
getex(key: RedisClient.KeyLike, ex: "EX", seconds: number): Promise<string | null>;
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Get the value of a key and set its expiration in milliseconds
|
|
588
|
+
* @param key The key to get
|
|
589
|
+
* @param px Set the specified expire time, in milliseconds
|
|
590
|
+
* @param milliseconds The number of milliseconds until expiration
|
|
591
|
+
* @returns Promise that resolves with the value of the key, or null if the key doesn't exist
|
|
592
|
+
*/
|
|
593
|
+
getex(key: RedisClient.KeyLike, px: "PX", milliseconds: number): Promise<string | null>;
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Get the value of a key and set its expiration at a specific Unix timestamp in seconds
|
|
597
|
+
* @param key The key to get
|
|
598
|
+
* @param exat Set the specified Unix time at which the key will expire, in seconds
|
|
599
|
+
* @param timestampSeconds The Unix timestamp in seconds
|
|
600
|
+
* @returns Promise that resolves with the value of the key, or null if the key doesn't exist
|
|
601
|
+
*/
|
|
602
|
+
getex(key: RedisClient.KeyLike, exat: "EXAT", timestampSeconds: number): Promise<string | null>;
|
|
603
|
+
|
|
604
|
+
/**
|
|
605
|
+
* Get the value of a key and set its expiration at a specific Unix timestamp in milliseconds
|
|
606
|
+
* @param key The key to get
|
|
607
|
+
* @param pxat Set the specified Unix time at which the key will expire, in milliseconds
|
|
608
|
+
* @param timestampMilliseconds The Unix timestamp in milliseconds
|
|
609
|
+
* @returns Promise that resolves with the value of the key, or null if the key doesn't exist
|
|
610
|
+
*/
|
|
611
|
+
getex(key: RedisClient.KeyLike, pxat: "PXAT", timestampMilliseconds: number): Promise<string | null>;
|
|
612
|
+
|
|
613
|
+
/**
|
|
614
|
+
* Get the value of a key and remove its expiration
|
|
615
|
+
* @param key The key to get
|
|
616
|
+
* @param persist Remove the expiration from the key
|
|
617
|
+
* @returns Promise that resolves with the value of the key, or null if the key doesn't exist
|
|
618
|
+
*/
|
|
619
|
+
getex(key: RedisClient.KeyLike, persist: "PERSIST"): Promise<string | null>;
|
|
620
|
+
|
|
577
621
|
/**
|
|
578
622
|
* Ping the server
|
|
579
623
|
* @returns Promise that resolves with "PONG" if the server is reachable, or throws an error if the server is not reachable
|