bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/api/import-meta.md

@@ -1,69 +0,0 @@
-The `import.meta` object is a way for a module to access information about itself. It's part of the JavaScript language, but its contents are not standardized. Each "host" (browser, runtime, etc) is free to implement any properties it wishes on the `import.meta` object.
-
-Bun implements the following properties.
-
-```ts#/path/to/project/file.ts
-import.meta.dir;   // => "/path/to/project"
-import.meta.file;  // => "file.ts"
-import.meta.path;  // => "/path/to/project/file.ts"
-import.meta.url;   // => "file:///path/to/project/file.ts"
-
-import.meta.main;  // `true` if this file is directly executed by `bun run`
-                   // `false` otherwise
-
-import.meta.resolve("zod"); // => "file:///path/to/project/node_modules/zod/index.js"
-```
-
-{% table %}
-
----
-
-- `import.meta.dir`
-- Absolute path to the directory containing the current file, e.g. `/path/to/project`. Equivalent to `__dirname` in CommonJS modules (and Node.js)
-
----
-
-- `import.meta.dirname`
-- An alias to `import.meta.dir`, for Node.js compatibility
-
----
-
-- `import.meta.env`
-- An alias to `process.env`.
-
----
-
-- `import.meta.file`
-- The name of the current file, e.g. `index.tsx`
-
----
-
-- `import.meta.path`
-- Absolute path to the current file, e.g. `/path/to/project/index.ts`. Equivalent to `__filename` in CommonJS modules (and Node.js)
-
----
-
-- `import.meta.filename`
-- An alias to `import.meta.path`, for Node.js compatibility
-
----
-
-- `import.meta.main`
-- Indicates whether the current file is the entrypoint to the current `bun` process. Is the file being directly executed by `bun run` or is it being imported?
-
----
-
-- `import.meta.resolve`
-- Resolve a module specifier (e.g. `"zod"` or `"./file.tsx"`) to a url. Equivalent to [`import.meta.resolve` in browsers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta#resolve)
-
-  ```ts
-  import.meta.resolve("zod");
-  // => "file:///path/to/project/node_modules/zod/index.ts"
-  ```
-
----
-
-- `import.meta.url`
-- A `string` url to the current file, e.g. `file:///path/to/project/index.ts`. Equivalent to [`import.meta.url` in browsers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta#url)
-
-{% /table %}

package/docs/benchmarks.md

@@ -1,120 +0,0 @@
-Bun.js focuses on performance, developer experience, and compatibility with the JavaScript ecosystem.
-
-## HTTP Requests
-
-```ts
-// http.ts
-export default {
-  port: 3000,
-  fetch(request: Request) {
-    return new Response("Hello World");
-  },
-};
-
-// bun ./http.ts
-```
-
-| Requests per second                                                    | OS    | CPU                            | Bun version |
-| ---------------------------------------------------------------------- | ----- | ------------------------------ | ----------- |
-| [260,000](https://twitter.com/jarredsumner/status/1512040623200616449) | macOS | Apple Silicon M1 Max           | 0.0.76      |
-| [160,000](https://twitter.com/jarredsumner/status/1511988933587976192) | Linux | AMD Ryzen 5 3600 6-Core 2.2ghz | 0.0.76      |
-
-{% details summary="See benchmark details" %}
-Measured with [`http_load_test`](https://github.com/uNetworking/uSockets/blob/master/examples/http_load_test.c) by running:
-
-```bash
-$ ./http_load_test  20 127.0.0.1 3000
-```
-
-{% /details %}
-
-## File System
-
-`cat` clone that runs [2x faster than GNU cat](https://twitter.com/jarredsumner/status/1511707890708586496) for large files on Linux
-
-```js
-// cat.js
-import { resolve } from "path";
-import { write, stdout, file, argv } from "bun";
-
-const path = resolve(argv.at(-1));
-
-await write(
-  // stdout is a Blob
-  stdout,
-  // file(path) returns a Blob - https://developer.mozilla.org/en-US/docs/Web/API/Blob
-  file(path),
-);
-```
-
-Run this with `bun cat.js /path/to/big/file`.
-
-## Reading from standard input
-
-```ts
-for await (const line of console) {
-  // line of text from stdin
-  console.log(line);
-}
-```
-
-## React SSR
-
-```js
-import { renderToReadableStream } from "react-dom/server";
-
-const dt = new Intl.DateTimeFormat();
-
-export default {
-  port: 3000,
-  async fetch(request: Request) {
-    return new Response(
-      await renderToReadableStream(
-        <html>
-          <head>
-            <title>Hello World</title>
-          </head>
-          <body>
-            <h1>Hello from React!</h1>
-            <p>The date is {dt.format(new Date())}</p>
-          </body>
-        </html>,
-      ),
-    );
-  },
-};
-```
-
-Write to stdout with `console.write`:
-
-```js
-// no trailing newline
-// works with strings and typed arrays
-console.write("Hello World!");
-```
-
-There are some more examples in the [examples](./examples) folder.
-
-PRs adding more examples are very welcome!
-
-## Fast paths for Web APIs
-
-Bun.js has fast paths for common use cases that make Web APIs live up to the performance demands of servers and CLIs.
-
-`Bun.file(path)` returns a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) that represents a lazily-loaded file.
-
-When you pass a file blob to `Bun.write`, Bun automatically uses a faster system call:
-
-```js
-const blob = Bun.file("input.txt");
-await Bun.write("output.txt", blob);
-```
-
-On Linux, this uses the [`copy_file_range`](https://man7.org/linux/man-pages/man2/copy_file_range.2.html) syscall and on macOS, this becomes `clonefile` (or [`fcopyfile`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/copyfile.3.html)).
-
-`Bun.write` also supports [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response) objects. It automatically converts to a [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
-
-```js
-// Eventually, this will stream the response to disk but today it buffers
-await Bun.write("index.html", await fetch("https://example.com"));
-```

package/docs/bun-flavored-toml.md

@@ -1,42 +0,0 @@
-[TOML](https://toml.io/) is a minimal configuration file format designed to be easy for humans to read.
-
-Bun implements a TOML parser with a few tweaks designed for better interoperability with INI files and with JavaScript.
-
-### ; and # are comments
-
-In Bun-flavored TOML, comments start with `#` or `;`
-
-```ini
-# This is a comment
-; This is also a comment
-```
-
-This matches the behavior of INI files.
-
-In TOML, comments start with `#`
-
-```toml
-# This is a comment
-```
-
-### String escape characters
-
-Bun-flavored adds a few more escape sequences to TOML to work better with JavaScript strings.
-
-```
-# Bun-flavored TOML extras
-\x{XX}     - ASCII           (U+00XX)
-\u{x+}     - unicode         (U+0000000X) - (U+XXXXXXXX)
-\v         - vertical tab
-
-# Regular TOML
-\b         - backspace       (U+0008)
-\t         - tab             (U+0009)
-\n         - linefeed        (U+000A)
-\f         - form feed       (U+000C)
-\r         - carriage return (U+000D)
-\"         - quote           (U+0022)
-\\         - backslash       (U+005C)
-\uXXXX     - unicode         (U+XXXX)
-\UXXXXXXXX - unicode         (U+XXXXXXXX)
-```

package/docs/bundler/css_modules.md

@@ -1,145 +0,0 @@
-# CSS Modules
-
-Bun's bundler also supports bundling [CSS modules](https://css-tricks.com/css-modules-part-1-need/) in addition to [regular CSS](/docs/bundler/css) with support for the following features:
-
-- Automatically detecting CSS module files (`.module.css`) with zero configuration
-- Composition (`composes` property)
-- Importing CSS modules into JSX/TSX
-- Warnings/errors for invalid usages of CSS modules
-
-A CSS module is a CSS file (with the `.module.css` extension) where are all class names and animations are scoped to the file. This helps you avoid class name collisions as CSS declarations are globally scoped by default.
-
-Under the hood, Bun's bundler transforms locally scoped class names into unique identifiers.
-
-## Getting started
-
-Create a CSS file with the `.module.css` extension:
-
-```css
-/* styles.module.css */
-.button {
-  color: red;
-}
-
-/* other-styles.module.css */
-.button {
-  color: blue;
-}
-```
-
-You can then import this file, for example into a TSX file:
-
-```tsx
-import styles from "./styles.module.css";
-import otherStyles from "./other-styles.module.css";
-
-export default function App() {
-  return (
-    <>
-      <button className={styles.button}>Red button!</button>
-      <button className={otherStyles.button}>Blue button!</button>
-    </>
-  );
-}
-```
-
-The `styles` object from importing the CSS module file will be an object with all class names as keys and
-their unique identifiers as values:
-
-```tsx
-import styles from "./styles.module.css";
-import otherStyles from "./other-styles.module.css";
-
-console.log(styles);
-console.log(otherStyles);
-```
-
-This will output:
-
-```ts
-{
-  button: "button_123";
-}
-
-{
-  button: "button_456";
-}
-```
-
-As you can see, the class names are unique to each file, avoiding any collisions!
-
-### Composition
-
-CSS modules allow you to _compose_ class selectors together. This lets you reuse style rules across multiple classes.
-
-For example:
-
-```css
-/* styles.module.css */
-.button {
-  composes: background;
-  color: red;
-}
-
-.background {
-  background-color: blue;
-}
-```
-
-Would be the same as writing:
-
-```css
-.button {
-  background-color: blue;
-  color: red;
-}
-
-.background {
-  background-color: blue;
-}
-```
-
-{% callout %}
-There are a couple rules to keep in mind when using `composes`:
-
-- A `composes` property must come before any regular CSS properties or declarations
-- You can only use `composes` on a **simple selector with a single class name**:
-
-```css
-#button {
-  /* Invalid! `#button` is not a class selector */
-  composes: background;
-}
-
-.button,
-.button-secondary {
-  /* Invalid! `.button, .button-secondary` is not a simple selector */
-  composes: background;
-}
-```
-
-{% /callout %}
-
-### Composing from a separate CSS module file
-
-You can also compose from a separate CSS module file:
-
-```css
-/* background.module.css */
-.background {
-  background-color: blue;
-}
-
-/* styles.module.css */
-.button {
-  composes: background from "./background.module.css";
-  color: red;
-}
-```
-
-{% callout %}
-When composing classes from separate files, be sure that they do not contain the same properties.
-
-The CSS module spec says that composing classes from separate files with conflicting properties is
-undefined behavior, meaning that the output may differ and be unreliable.
-{% /callout %}