aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/http/file-uploads.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/http/file-uploads.md')
-rw-r--r--docs/guides/http/file-uploads.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/docs/guides/http/file-uploads.md b/docs/guides/http/file-uploads.md
new file mode 100644
index 000000000..a708a238a
--- /dev/null
+++ b/docs/guides/http/file-uploads.md
@@ -0,0 +1,94 @@
+---
+name: Upload files via HTTP using FormData
+---
+
+To upload files via HTTP with Bun, use the [`FormData`](https://developer.mozilla.org/en-US/docs/Web/API/FormData) API. Let's start with a HTTP server that serves a simple HTML web form.
+
+```ts#index.ts
+const server = Bun.serve({
+ port: 4000,
+ async fetch(req) {
+ const url = new URL(req.url);
+
+ // return index.html for root path
+ if (url.pathname === "/")
+ return new Response(Bun.file("index.html"), {
+ headers: {
+ "Content-Type": "text/html",
+ },
+ });
+
+ return new Response("Not Found", { status: 404 });
+ },
+});
+
+console.log(`Listening on http://localhost:${server.port}`);
+```
+
+---
+
+We can define our HTML form in another file, `index.html`.
+
+```html#index.html
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8" />
+ <title>Form</title>
+ </head>
+ <body>
+ <form action="/action" method="post" enctype="multipart/form-data">
+ <input type="text" name="name" placeholder="Name" />
+ <input type="file" name="profilePicture" />
+ <input type="submit" value="Submit" />
+ </form>
+ </body>
+</html>
+```
+
+---
+
+At this point, we can run the server and visit [`localhost:4000`](http://localhost:4000) to see our form.
+
+```bash
+$ bun run index.ts
+Listening on http://localhost:4000
+```
+
+---
+
+Our form will send a `POST` request to the `/action` endpoint with the form data. Let's handle that request in our server.
+
+First we use the [`.formData()`](https://developer.mozilla.org/en-US/docs/Web/API/Request/formData) method on the incoming `Request` to asynchonously parse its contents to a `FormData` instance. Then we can use the [`.get()`](https://developer.mozilla.org/en-US/docs/Web/API/FormData/get) method to extract the value of the `name` and `profilePicture` fields. Here `name` corresponds to a `string` and `profilePicture` is a `Blob`.
+
+Finally, we write the `Blob` to disk using [`Bun.write()`](/docs/api/file-io#writing-files-bun-write).
+
+```ts-diff#index.ts
+const server = Bun.serve({
+ port: 4000,
+ async fetch(req) {
+ const url = new URL(req.url);
+
+ // return index.html for root path
+ if (url.pathname === "/")
+ return new Response(Bun.file("index.html"), {
+ headers: {
+ "Content-Type": "text/html",
+ },
+ });
+
++ // parse formdata at /action
++ if (url.pathname === '/action') {
++ const formdata = await req.formData();
++ const name = formdata.get('name');
++ const profilePicture = formdata.get('profilePicture');+
++ if (!profilePicture) throw new Error('Must upload a profile picture.');
++ // write profilePicture to disk
++ await Bun.write('profilePicture.png', profilePicture);
++ return new Response("Success");
++ }
+
+ return new Response("Not Found", { status: 404 });
+ },
+});
+```