The page primarily documents the Bun-native `Bun.serve` API. Bun also implements [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and the Node.js [`http`](https://nodejs.org/api/http.html) and [`https`](https://nodejs.org/api/https.html) modules. {% callout %} These modules have been re-implemented to use Bun's fast internal HTTP infrastructure. Feel free to use these modules directly; frameworks like [Express](https://expressjs.com/) that depend on these modules should work out of the box. For granular compatibility information, see [Runtime > Node.js APIs](/docs/runtime/nodejs-apis). {% /callout %} To start a high-performance HTTP server with a clean API, the recommended approach is [`Bun.serve`](#start-a-server-bun-serve). ## `Bun.serve()` Start an HTTP server in Bun with `Bun.serve`. ```ts Bun.serve({ fetch(req) { return new Response(`Bun!`); }, }); ``` The `fetch` handler handles incoming requests. It receives a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) object and returns a [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) or `Promise`. ```ts Bun.serve({ fetch(req) { const url = new URL(req.url); if (url.pathname === "/") return new Response(`Home page!`); if (url.pathname === "/blog") return new Response("Blog!"); return new Response(`404!`); }, }); ``` To configure which port and hostname the server will listen on: ```ts Bun.serve({ port: 8080, // defaults to $PORT, then 3000 hostname: "mydomain.com", // defaults to "0.0.0.0" fetch(req) { return new Response(`404!`); }, }); ``` ## Error handling To activate development mode, set `development: true`. By default, development mode is _enabled_ unless `NODE_ENV` is `production`. ```ts Bun.serve({ development: true, fetch(req) { throw new Error("woops!"); }, }); ``` In development mode, Bun will surface errors in-browser with a built-in error page. {% image src="/images/exception_page.png" caption="Bun's built-in 500 page" /%} To handle server-side errors, implement an `error` handler. This function should return a `Response` to served to the client when an error occurs. This response will supercede Bun's default error page in `development` mode. ```ts Bun.serve({ fetch(req) { throw new Error("woops!"); }, error(error: Error) { return new Response(`

${error}\n${error.stack}

`, { headers: { "Content-Type": "text/html", }, }); }, }); ``` {% callout %} **Note** — Full debugger support is planned. {% /callout %} The call to `Bun.serve` returns a `Server` object. To stop the server, call the `.stop()` method. ```ts const server = Bun.serve({ fetch() { return new Response("Bun!"); }, }); server.stop(); ``` ## TLS Bun supports TLS out of the box, powered by [OpenSSL](https://www.openssl.org/). Enable TLS by passing in a value for `key` and `cert`; both are required to enable TLS. If needed, supply a `passphrase` to decrypt the `keyFile`. ```ts Bun.serve({ fetch(req) { return new Response("Hello!!!"); }, // can be string, BunFile, TypedArray, Buffer, or array thereof key: Bun.file("./key.pem"), cert: Bun.file("./cert.pem"), // passphrase, only required if key is encrypted passphrase: "super-secret", }); ``` The `key` and `cert` fields expect the _contents_ of your TLS key and certificate. This can be a string, `BunFile`, `TypedArray`, or `Buffer`. ```ts Bun.serve({ fetch() {}, // BunFile key: Bun.file("./key.pem"), // Buffer key: fs.readFileSync("./key.pem"), // string key: fs.readFileSync("./key.pem", "utf8"), // array of above key: [Bun.file('./key1.pem'), Bun.file('./key2.pem')], }); ``` {% callout %} **Note** — Earlier versions of Bun supported passing a file path as `keyFile` and `certFile`; this has been deprecated as of `v0.6.3`. {% /callout %} Optionally, you can override the trusted CA certificates by passing a value for `ca`. By default, the server will trust the list of well-known CAs curated by Mozilla. When `ca` is specified, the Mozilla list is overwritten. ```ts Bun.serve({ fetch(req) { return new Response("Hello!!!"); }, key: Bun.file("./key.pem"), // path to TLS key cert: Bun.file("./cert.pem"), // path to TLS cert ca: Bun.file("./ca.pem"), // path to root CA certificate }); ``` To override Diffie-Helman parameters: ```ts Bun.serve({ // ... dhParamsFile: "./dhparams.pem", // path to Diffie Helman parameters }); ``` ## Hot reloading Thus far, the examples on this page have used the explicit `Bun.serve` API. Bun also supports an alternate syntax. ```ts#server.ts import {type Serve} from "bun"; export default { fetch(req) { return new Response(`Bun!`); }, } satisfies Serve; ``` Instead of passing the server options into `Bun.serve`, export it. This file can be executed as-is; when Bun runs a file with a `default` export containing a `fetch` handler, it passes it into `Bun.serve` under the hood. This syntax has one major advantage: it is hot-reloadable out of the box. When any source file is changed, Bun will reload the server with the updated code _without restarting the process_. This makes hot reloads nearly instantaneous. Use the `--hot` flag when starting the server to enable hot reloading. ```bash $ bun --hot server.ts ``` It's possible to configure hot reloading while using the explicit `Bun.serve` API; for details refer to [Runtime > Hot reloading](/docs/runtime/hot). ## Streaming files To stream a file, return a `Response` object with a `BunFile` object as the body. ```ts import { serve, file } from "bun"; serve({ fetch(req) { return new Response(Bun.file("./hello.txt")); }, }); ``` {% callout %} ⚡️ **Speed** — Bun automatically uses the [`sendfile(2)`](https://man7.org/linux/man-pages/man2/sendfile.2.html) system call when possible, enabling zero-copy file transfers in the kernel—the fastest way to send files. {% /callout %} **[v0.3.0+]** You can send part of a file using the [`slice(start, end)`](https://developer.mozilla.org/en-US/docs/Web/API/Blob/slice) method on the `Bun.file` object. This automatically sets the `Content-Range` and `Content-Length` headers on the `Response` object. ```ts Bun.serve({ fetch(req) { // parse `Range` header const [start = 0, end = Infinity] = req.headers .get("Range") // Range: bytes=0-100 .split("=") // ["Range: bytes", "0-100"] .at(-1) // "0-100" .split("-") // ["0", "100"] .map(Number); // [0, 100] // return a slice of the file const bigFile = Bun.file("./big-video.mp4"); return new Response(bigFile.slice(start, end)); }, }); ``` ## Benchmarks Below are Bun and Node.js implementations of a simple HTTP server that responds `Bun!` to each incoming `Request`. {% codetabs %} ```ts#Bun Bun.serve({ fetch(req: Request) { return new Response(`Bun!`); }, port: 3000, }); ``` ```ts#Node require("http") .createServer((req, res) => res.end("Bun!")) .listen(8080); ``` {% /codetabs %} The `Bun.serve` server can handle roughly 2.5x more requests per second than Node.js on Linux. {% table %} - Runtime - Requests per second --- - Node 16 - ~64,000 --- - Bun - ~160,000 {% /table %} {% image width="499" alt="image" src="https://user-images.githubusercontent.com/709451/162389032-fc302444-9d03-46be-ba87-c12bd8ce89a0.png" /%} ## Reference {% details summary="See TypeScript definitions" %} ```ts interface Bun { serve(options: { fetch: (req: Request, server: Server) => Response | Promise; hostname?: string; port?: number; development?: boolean; error?: (error: Error) => Response | Promise; keyFile?: string; certFile?: string; caFile?: string; dhParamsFile?: string; passphrase?: string; maxRequestBodySize?: number; lowMemoryMode?: boolean; }): Server; } interface Server { development: boolean; hostname: string; port: number; pendingRequests: number; stop(): void; } ``` {% /details %} xes-3129'>jarred/fixes-3129 Unnamed repository; edit this file 'description' to name the repository.

about summary refs log tree commit diff

path: root/integration/snippets/react-context-value-func.tsx (unfollow)

Age	Commit message (Expand)	Author	Files	Lines
2021-12-16	[transpiler] Don't insert `import` statements for disabled `require()`	Jarred Sumner	1	-84/+40
2021-12-16	Update Makefilebun-v0.0.54	Jarred Sumner	1	-0/+1
2021-12-16	Bump again I guess	Jarred Sumner	1	-1/+1
2021-12-16	:camera:bun-v0.0.53	Jarred Sumner	27	-125/+132
2021-12-16	Print errors below warnings	Jarred Sumner	1	-4/+31
2021-12-16	[bun bun] Fix a race condition introduced in #55ff681976f7bae5a428c409061991c...	Jarred Sumner	2	-4/+9
2021-12-16	Update js_printer.zig	Jarred Sumner	1	-1/+8
2021-12-16	[http] Fix bug with `Link` header	Jarred Sumner	1	-1/+5
2021-12-16	Update js_printer.zig	Jarred Sumner	1	-1/+1
2021-12-16	:camera:	Jarred Sumner	30	-129/+226
2021-12-16	bump build id	Jarred Sumner	1	-1/+1
2021-12-16	[macros] Do not automatically load node_modules.bun in macros	Jarred Sumner	1	-11/+11
2021-12-16	[macros] Slightly improve error message if macros fail to load	Jarred Sumner	1	-2/+7
2021-12-16	[bundler][JS transpiler] Improve reliability of ESM <> CommonJS interop	Jarred Sumner	6	-242/+165
2021-12-16	[http] Ensure errors from macros can see source code	Jarred Sumner	1	-1/+19
2021-12-16	[internal] disable debug workaround	Jarred Sumner	1	-1/+1
2021-12-16	[bundler] Fix edgecase where certain modules would load unbundled versions	Jarred Sumner	2	-2/+17
2021-12-16	[resolver] Change extension order based on import kind	Jarred Sumner	1	-1/+6
2021-12-16	[resolver] When importing from an ES Module, prefer `.{m,c}{t,j}s`	Jarred Sumner	1	-2/+28
2021-12-15	wip fix live bindings	Jarred Sumner	6	-418/+359
2021-12-15	[JS transpiler] Simplify CommonJS interop callback	Jarred Sumner	2	-67/+65
2021-12-15	[JS transpiler] Ensure reserved words don't end up in nonUniqueIdentifier()	Jarred Sumner	2	-0/+18
2021-12-15	[JS Parser] Add regression test	Jarred Sumner	1	-0/+14
2021-12-15	[JS Parser] Fix bug with template literals that create new scopes in the tag ...	Jarred Sumner	1	-4/+4
2021-12-11	Add a resource hint for preloading node_modules.bun and route asset in the fa...	Jarred Sumner	1	-1/+43
2021-12-04	[resolver] Do not throw on require()/import errors when they're caught (and i...	Jarred Sumner	2	-53/+62
2021-11-26	Bumpbun-v0.0.52	Jarred Sumner	1	-1/+1
2021-11-25	Fix occasional segfault when parsing JSON in http server	Jarred Sumner	1	-2/+2
2021-11-25	Revert "Merge pull request #70 from Jarred-Sumner/lithdew/picohttp-mimalloc"	Jarred Sumner	2	-153/+132
2021-11-24	mimalloc: patch malloc/freelithdew/picohttp-mimalloc	Kenta Iwasaki	2	-7/+35
2021-11-24	deps: add missing mimalloc dep to jsc bindings header generator	Kenta Iwasaki	2	-2/+3
2021-11-24	deps: build picohttp and mimalloc using zig	Kenta Iwasaki	2	-131/+123
2021-11-23	update Next version on global	Jack Hanford	1	-1/+1
2021-11-23	Update build-id	Jarred Sumner	1	-1/+1
2021-11-23	fix shallow routing	Jack Hanford	1	-4/+6
2021-11-23	remove comment	Jack Hanford	1	-1/+0
2021-11-23	add react-dom as devDep	Jack Hanford	1	-0/+1
2021-11-23	stop installing textencoder	Jack Hanford	3	-2/+308
2021-11-23	begin addressing more feedback	Jack Hanford	1	-3/+3
2021-11-22	remove .then	Jack Hanford	1	-12/+3
2021-11-22	another try	Jack Hanford	2	-5/+1
2021-11-22	add type fns	Jack Hanford	1	-1/+4