bun-types 1.2.3-canary.20250217T140554 → 1.2.3-canary.20250219T140606
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/sql.md +1 -0
- package/docs/cli/publish.md +1 -1
- package/docs/guides/ecosystem/nuxt.md +1 -1
- package/docs/guides/ecosystem/render.md +1 -1
- package/docs/guides/html-rewriter/extract-links.md +68 -0
- package/docs/guides/html-rewriter/extract-social-meta.md +93 -0
- 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 +8 -6
- package/docs/runtime/debugger.md +3 -3
- package/docs/test/dom.md +1 -1
- package/package.json +1 -1
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.20250219T140606
|
|
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.20250219T140606"
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
Configure the output stream by passing one of the following values to `stdout/stderr`:
|
package/docs/api/sql.md
CHANGED
|
@@ -520,6 +520,7 @@ The client provides typed errors for different failure scenarios:
|
|
|
520
520
|
| `ERR_POSTGRES_SERVER_ERROR` | General error from PostgreSQL server |
|
|
521
521
|
| `ERR_POSTGRES_INVALID_QUERY_BINDING` | Invalid parameter binding |
|
|
522
522
|
| `ERR_POSTGRES_QUERY_CANCELLED` | Query was cancelled |
|
|
523
|
+
| `ERR_POSTGRES_NOT_TAGGED_CALL` | Query was called without a tagged call |
|
|
523
524
|
|
|
524
525
|
### Data Type Errors
|
|
525
526
|
|
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.20250219T140606 (16b4bf34)
|
|
13
13
|
+ @nuxt/devtools@0.8.2
|
|
14
14
|
+ nuxt@3.7.0
|
|
15
15
|
785 packages installed [2.67s]
|
|
@@ -70,7 +70,7 @@ In the Render UI, provide the following values during web service creation:
|
|
|
70
70
|
| ----------------- | ------------- |
|
|
71
71
|
| **Runtime** | `Node` |
|
|
72
72
|
| **Build Command** | `bun install` |
|
|
73
|
-
| **Start Command** | `bun app.
|
|
73
|
+
| **Start Command** | `bun app.ts` |
|
|
74
74
|
|
|
75
75
|
---
|
|
76
76
|
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Extract links from a webpage using HTMLRewriter
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## Extract links from a webpage
|
|
6
|
+
|
|
7
|
+
Bun's [HTMLRewriter](https://bun.sh/docs/api/html-rewriter) API can be used to efficiently extract links from HTML content. It works by chaining together CSS selectors to match the elements, text, and attributes you want to process. This is a simple example of how to extract links from a webpage. You can pass `.transform` a `Response`, `Blob`, or `string`.
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
async function extractLinks(url: string) {
|
|
11
|
+
const links = new Set<string>();
|
|
12
|
+
const response = await fetch(url);
|
|
13
|
+
|
|
14
|
+
const rewriter = new HTMLRewriter().on("a[href]", {
|
|
15
|
+
element(el) {
|
|
16
|
+
const href = el.getAttribute("href");
|
|
17
|
+
if (href) {
|
|
18
|
+
links.add(href);
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
// Wait for the response to be processed
|
|
24
|
+
await rewriter.transform(response).blob();
|
|
25
|
+
console.log([...links]); // ["https://bun.sh", "/docs", ...]
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
// Extract all links from the Bun website
|
|
29
|
+
await extractLinks("https://bun.sh");
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Convert relative URLs to absolute
|
|
35
|
+
|
|
36
|
+
When scraping websites, you often want to convert relative URLs (like `/docs`) to absolute URLs. Here's how to handle URL resolution:
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
async function extractLinksFromURL(url: string) {
|
|
40
|
+
const response = await fetch(url);
|
|
41
|
+
const links = new Set<string>();
|
|
42
|
+
|
|
43
|
+
const rewriter = new HTMLRewriter().on("a[href]", {
|
|
44
|
+
element(el) {
|
|
45
|
+
const href = el.getAttribute("href");
|
|
46
|
+
if (href) {
|
|
47
|
+
// Convert relative URLs to absolute
|
|
48
|
+
try {
|
|
49
|
+
const absoluteURL = new URL(href, url).href;
|
|
50
|
+
links.add(absoluteURL);
|
|
51
|
+
} catch {
|
|
52
|
+
links.add(href);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
// Wait for the response to be processed
|
|
59
|
+
await rewriter.transform(response).blob();
|
|
60
|
+
return [...links];
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const websiteLinks = await extractLinksFromURL("https://example.com");
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
See [Docs > API > HTMLRewriter](https://bun.sh/docs/api/html-rewriter) for complete documentation on HTML transformation with Bun.
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Extract social share images and Open Graph tags
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## Extract social share images and Open Graph tags
|
|
6
|
+
|
|
7
|
+
Bun's [HTMLRewriter](https://bun.sh/docs/api/html-rewriter) API can be used to efficiently extract social share images and Open Graph metadata from HTML content. This is particularly useful for building link preview features, social media cards, or web scrapers. We can use HTMLRewriter to match CSS selectors to HTML elements, text, and attributes we want to process.
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
interface SocialMetadata {
|
|
11
|
+
title?: string;
|
|
12
|
+
description?: string;
|
|
13
|
+
image?: string;
|
|
14
|
+
url?: string;
|
|
15
|
+
siteName?: string;
|
|
16
|
+
type?: string;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
async function extractSocialMetadata(url: string): Promise<SocialMetadata> {
|
|
20
|
+
const metadata: SocialMetadata = {};
|
|
21
|
+
const response = await fetch(url);
|
|
22
|
+
|
|
23
|
+
const rewriter = new HTMLRewriter()
|
|
24
|
+
// Extract Open Graph meta tags
|
|
25
|
+
.on('meta[property^="og:"]', {
|
|
26
|
+
element(el) {
|
|
27
|
+
const property = el.getAttribute("property");
|
|
28
|
+
const content = el.getAttribute("content");
|
|
29
|
+
if (property && content) {
|
|
30
|
+
// Convert "og:image" to "image" etc.
|
|
31
|
+
const key = property.replace("og:", "") as keyof SocialMetadata;
|
|
32
|
+
metadata[key] = content;
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
})
|
|
36
|
+
// Extract Twitter Card meta tags as fallback
|
|
37
|
+
.on('meta[name^="twitter:"]', {
|
|
38
|
+
element(el) {
|
|
39
|
+
const name = el.getAttribute("name");
|
|
40
|
+
const content = el.getAttribute("content");
|
|
41
|
+
if (name && content) {
|
|
42
|
+
const key = name.replace("twitter:", "") as keyof SocialMetadata;
|
|
43
|
+
// Only use Twitter Card data if we don't have OG data
|
|
44
|
+
if (!metadata[key]) {
|
|
45
|
+
metadata[key] = content;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
})
|
|
50
|
+
// Fallback to regular meta tags
|
|
51
|
+
.on('meta[name="description"]', {
|
|
52
|
+
element(el) {
|
|
53
|
+
const content = el.getAttribute("content");
|
|
54
|
+
if (content && !metadata.description) {
|
|
55
|
+
metadata.description = content;
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
})
|
|
59
|
+
// Fallback to title tag
|
|
60
|
+
.on("title", {
|
|
61
|
+
text(text) {
|
|
62
|
+
if (!metadata.title) {
|
|
63
|
+
metadata.title = text.text;
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
// Process the response
|
|
69
|
+
await rewriter.transform(response).blob();
|
|
70
|
+
|
|
71
|
+
// Convert relative image URLs to absolute
|
|
72
|
+
if (metadata.image && !metadata.image.startsWith("http")) {
|
|
73
|
+
try {
|
|
74
|
+
metadata.image = new URL(metadata.image, url).href;
|
|
75
|
+
} catch {
|
|
76
|
+
// Keep the original URL if parsing fails
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
return metadata;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
// Example usage
|
|
84
|
+
const metadata = await extractSocialMetadata("https://bun.sh");
|
|
85
|
+
console.log(metadata);
|
|
86
|
+
// {
|
|
87
|
+
// title: "Bun — A fast all-in-one JavaScript runtime",
|
|
88
|
+
// description: "Bundle, transpile, install and run JavaScript & TypeScript projects — all in Bun. Bun is a fast all-in-one JavaScript runtime & toolkit designed for speed, complete with a bundler, test runner, and Node.js-compatible package manager.",
|
|
89
|
+
// image: "https://bun.sh/share.jpg",
|
|
90
|
+
// type: "website",
|
|
91
|
+
// ...
|
|
92
|
+
// }
|
|
93
|
+
```
|
|
@@ -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.20250219T140606"
|
|
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.20250219T140606"
|
|
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.20250219T140606
|
|
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.20250219T140606 (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.20250219T140606 (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.20250219T140606 (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.20250219T140606 (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.20250219T140606 (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.20250219T140606 (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.20250219T140606"
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
```bash#npm
|
|
@@ -147,6 +147,7 @@ If the command runs successfully but `bun --version` is not recognized, it means
|
|
|
147
147
|
[System.EnvironmentVariableTarget]::User
|
|
148
148
|
)
|
|
149
149
|
```
|
|
150
|
+
|
|
150
151
|
After running the command, restart your terminal and test with `bun --version`
|
|
151
152
|
|
|
152
153
|
{% /details %}
|
|
@@ -188,10 +189,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
|
|
|
188
189
|
|
|
189
190
|
### Installing a specific version of Bun on Linux/Mac
|
|
190
191
|
|
|
191
|
-
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.
|
|
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.3-canary.20250219T140606`.
|
|
192
193
|
|
|
193
194
|
```sh
|
|
194
|
-
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.
|
|
195
|
+
$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.3-canary.20250219T140606"
|
|
195
196
|
```
|
|
196
197
|
|
|
197
198
|
### Installing a specific version of Bun on Windows
|
|
@@ -200,7 +201,7 @@ On Windows, you can install a specific version of Bun by passing the version num
|
|
|
200
201
|
|
|
201
202
|
```sh
|
|
202
203
|
# PowerShell:
|
|
203
|
-
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.
|
|
204
|
+
$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.3-canary.20250219T140606"
|
|
204
205
|
```
|
|
205
206
|
|
|
206
207
|
## Downloading Bun binaries directly
|
|
@@ -219,11 +220,12 @@ For convenience, here are download links for the latest version:
|
|
|
219
220
|
- [`bun-linux-aarch64.zip`](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-aarch64.zip)
|
|
220
221
|
- [`bun-linux-aarch64-musl.zip`](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-aarch64-musl.zip)
|
|
221
222
|
- [`bun-darwin-x64.zip`](https://github.com/oven-sh/bun/releases/latest/download/bun-darwin-x64.zip)
|
|
222
|
-
- [`bun-darwin-x64-baseline.zip`](https://github.com/oven-sh/bun/releases/latest/download/bun-darwin-x64-baseline.zip)
|
|
223
223
|
|
|
224
224
|
The `musl` binaries are built for distributions that do not ship with the glibc libraries by default, instead relying on musl. The two most popular distros are Void Linux and Alpine Linux, with the latter is used heavily in Docker containers. If you encounter an error like the following: `bun: /lib/x86_64-linux-gnu/libm.so.6: version GLIBC_2.29' not found (required by bun)`, try using the musl binary. Bun's install script automatically chooses the correct binary for your system.
|
|
225
225
|
|
|
226
|
-
|
|
226
|
+
Bun's `x64` binaries target the Haswell CPU architecture, which means they require AVX and AVX2 instructions. For Linux and Windows, the `x64-baseline` binaries are also available which target the Nehalem architecture. If you run into an "Illegal Instruction" error when running Bun, try using the `baseline` binaries instead. Bun's install scripts automatically chooses the correct binary for your system which helps avoid this issue. Baseline builds are slower than regular builds, so use them only if necessary.
|
|
227
|
+
|
|
228
|
+
Bun also publishes `darwin-x64-baseline` binaries, but these are just a copy of the `darwin-x64` ones so they still have the same CPU requirement. We only maintain these since some tools expect them to exist. Bun requires macOS 13.0 or later, which does not support any CPUs that don't meet our requirement.
|
|
227
229
|
|
|
228
230
|
<!--
|
|
229
231
|
## Native
|
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.20250219T140606" -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.20250219T140606
|
|
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.20250219T140606
|
|
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