bun-types 1.3.2-canary.20251106T140813 → 1.3.2

package/docs/snippets/cli/run.mdx

@@ -0,0 +1,293 @@
+# CLI Usage
+
+```bash
+bun run <file or script>
+```
+
+### General Execution Options
+
+<ParamField path="--silent" type="boolean">
+  Don't print the script command
+</ParamField>
+
+<ParamField path="--if-present" type="boolean">
+  Exit without an error if the entrypoint does not exist
+</ParamField>
+
+<ParamField path="--eval" type="string">
+  Evaluate argument as a script. Alias: <code>-e</code>
+</ParamField>
+
+<ParamField path="--print" type="string">
+  Evaluate argument as a script and print the result. Alias: <code>-p</code>
+</ParamField>
+
+<ParamField path="--help" type="boolean">
+  Display this menu and exit. Alias: <code>-h</code>
+</ParamField>
+
+### Workspace Management
+
+<ParamField path="--elide-lines" type="number" default="10">
+  Number of lines of script output shown when using --filter (default: 10). Set to 0 to show all lines
+</ParamField>
+
+<ParamField path="--filter" type="string">
+  Run a script in all workspace packages matching the pattern. Alias: <code>-F</code>
+</ParamField>
+
+<ParamField path="--workspaces" type="boolean">
+  Run a script in all workspace packages (from the <code>workspaces</code> field in <code>package.json</code>)
+</ParamField>
+
+### Runtime &amp; Process Control
+
+<ParamField path="--bun" type="boolean">
+  Force a script or package to use Bun's runtime instead of Node.js (via symlinking node). Alias: <code>-b</code>
+</ParamField>
+
+<ParamField path="--shell" type="string">
+  Control the shell used for <code>package.json</code> scripts. Supports either <code>bun</code> or <code>system</code>
+</ParamField>
+
+<ParamField path="--smol" type="boolean">
+  Use less memory, but run garbage collection more often
+</ParamField>
+
+<ParamField path="--expose-gc" type="boolean">
+  Expose <code>gc()</code> on the global object. Has no effect on <code>Bun.gc()</code>
+</ParamField>
+
+<ParamField path="--no-deprecation" type="boolean">
+  Suppress all reporting of the custom deprecation
+</ParamField>
+
+<ParamField path="--throw-deprecation" type="boolean">
+  Determine whether or not deprecation warnings result in errors
+</ParamField>
+
+<ParamField path="--title" type="string">
+  Set the process title
+</ParamField>
+
+<ParamField path="--zero-fill-buffers" type="boolean">
+  Boolean to force <code>Buffer.allocUnsafe(size)</code> to be zero-filled
+</ParamField>
+
+<ParamField path="--no-addons" type="boolean">
+  Throw an error if <code>process.dlopen</code> is called, and disable export condition <code>node-addons</code>
+</ParamField>
+
+<ParamField path="--unhandled-rejections" type="string">
+  One of <code>strict</code>, <code>throw</code>, <code>warn</code>, <code>none</code>, or{" "}
+  <code>warn-with-error-code</code>
+</ParamField>
+
+<ParamField path="--console-depth" type="number" default="2">
+  Set the default depth for <code>console.log</code> object inspection (default: 2)
+</ParamField>
+
+### Development Workflow
+
+<ParamField path="--watch" type="boolean">
+  Automatically restart the process on file change
+</ParamField>
+
+<ParamField path="--hot" type="boolean">
+  Enable auto reload in the Bun runtime, test runner, or bundler
+</ParamField>
+
+<ParamField path="--no-clear-screen" type="boolean">
+  Disable clearing the terminal screen on reload when --hot or --watch is enabled
+</ParamField>
+
+### Debugging
+
+<ParamField path="--inspect" type="string">
+  Activate Bun's debugger
+</ParamField>
+
+<ParamField path="--inspect-wait" type="string">
+  Activate Bun's debugger, wait for a connection before executing
+</ParamField>
+
+<ParamField path="--inspect-brk" type="string">
+  Activate Bun's debugger, set breakpoint on first line of code and wait
+</ParamField>
+
+### Dependency &amp; Module Resolution
+
+<ParamField path="--preload" type="string">
+  Import a module before other modules are loaded. Alias: <code>-r</code>
+</ParamField>
+
+<ParamField path="--require" type="string">
+  Alias of --preload, for Node.js compatibility
+</ParamField>
+
+<ParamField path="--import" type="string">
+  Alias of --preload, for Node.js compatibility
+</ParamField>
+
+<ParamField path="--no-install" type="boolean">
+  Disable auto install in the Bun runtime
+</ParamField>
+
+<ParamField path="--install" type="string" default="auto">
+  Configure auto-install behavior. One of <code>auto</code> (default, auto-installs when no node_modules),{" "}
+  <code>fallback</code> (missing packages only), <code>force</code> (always)
+</ParamField>
+
+<ParamField path="-i" type="boolean">
+  Auto-install dependencies during execution. Equivalent to --install=fallback
+</ParamField>
+
+<ParamField path="--prefer-offline" type="boolean">
+  Skip staleness checks for packages in the Bun runtime and resolve from disk
+</ParamField>
+
+<ParamField path="--prefer-latest" type="boolean">
+  Use the latest matching versions of packages in the Bun runtime, always checking npm
+</ParamField>
+
+<ParamField path="--conditions" type="string">
+  Pass custom conditions to resolve
+</ParamField>
+
+<ParamField path="--main-fields" type="string">
+  Main fields to lookup in <code>package.json</code>. Defaults to --target dependent
+</ParamField>
+
+<ParamField path="--preserve-symlinks" type="boolean">
+  Preserve symlinks when resolving files
+</ParamField>
+
+<ParamField path="--preserve-symlinks-main" type="boolean">
+  Preserve symlinks when resolving the main entry point
+</ParamField>
+
+<ParamField path="--extension-order" type="string" default=".tsx,.ts,.jsx,.js,.json">
+  Defaults to: <code>.tsx,.ts,.jsx,.js,.json</code>
+</ParamField>
+
+### Transpilation &amp; Language Features
+
+<ParamField path="--tsconfig-override" type="string">
+  Specify custom <code>tsconfig.json</code>. Default <code>$cwd/tsconfig.json</code>
+</ParamField>
+
+<ParamField path="--define" type="string">
+  Substitute K:V while parsing, e.g. <code>--define process.env.NODE_ENV:"development"</code>. Values are parsed as
+  JSON. Alias: <code>-d</code>
+</ParamField>
+
+<ParamField path="--drop" type="string">
+  Remove function calls, e.g. <code>--drop=console</code> removes all <code>console.*</code> calls
+</ParamField>
+
+<ParamField path="--loader" type="string">
+  Parse files with <code>.ext:loader</code>, e.g. <code>--loader .js:jsx</code>. Valid loaders: <code>js</code>,{" "}
+  <code>jsx</code>, <code>ts</code>, <code>tsx</code>, <code>json</code>, <code>toml</code>, <code>text</code>,{" "}
+  <code>file</code>, <code>wasm</code>, <code>napi</code>. Alias: <code>-l</code>
+</ParamField>
+
+<ParamField path="--no-macros" type="boolean">
+  Disable macros from being executed in the bundler, transpiler and runtime
+</ParamField>
+
+<ParamField path="--jsx-factory" type="string">
+  Changes the function called when compiling JSX elements using the classic JSX runtime
+</ParamField>
+
+<ParamField path="--jsx-fragment" type="string">
+  Changes the function called when compiling JSX fragments
+</ParamField>
+
+<ParamField path="--jsx-import-source" type="string" default="react">
+  Declares the module specifier to be used for importing the jsx and jsxs factory functions. Default: <code>react</code>
+</ParamField>
+
+<ParamField path="--jsx-runtime" type="string" default="automatic">
+  <code>automatic</code> (default) or <code>classic</code>
+</ParamField>
+
+<ParamField path="--jsx-side-effects" type="boolean">
+  Treat JSX elements as having side effects (disable pure annotations)
+</ParamField>
+
+<ParamField path="--ignore-dce-annotations" type="boolean">
+  Ignore tree-shaking annotations such as <code>@__PURE__</code>
+</ParamField>
+
+### Networking &amp; Security
+
+<ParamField path="--port" type="number">
+  Set the default port for <code>Bun.serve</code>
+</ParamField>
+
+<ParamField path="--fetch-preconnect" type="string">
+  Preconnect to a URL while code is loading
+</ParamField>
+
+<ParamField path="--max-http-header-size" type="number" default="16384">
+  Set the maximum size of HTTP headers in bytes. Default is 16KiB
+</ParamField>
+
+<ParamField path="--dns-result-order" type="string" default="verbatim">
+  Set the default order of DNS lookup results. Valid orders: <code>verbatim</code> (default), <code>ipv4first</code>,{" "}
+  <code>ipv6first</code>
+</ParamField>
+
+<ParamField path="--use-system-ca" type="boolean">
+  Use the system's trusted certificate authorities
+</ParamField>
+
+<ParamField path="--use-openssl-ca" type="boolean">
+  Use OpenSSL's default CA store
+</ParamField>
+
+<ParamField path="--use-bundled-ca" type="boolean">
+  Use bundled CA store
+</ParamField>
+
+<ParamField path="--redis-preconnect" type="boolean">
+  Preconnect to <code>$REDIS_URL</code> at startup
+</ParamField>
+
+<ParamField path="--sql-preconnect" type="boolean">
+  Preconnect to PostgreSQL at startup
+</ParamField>
+
+<ParamField path="--user-agent" type="string">
+  Set the default User-Agent header for HTTP requests
+</ParamField>
+
+### Global Configuration &amp; Context
+
+<ParamField path="--env-file" type="string">
+  Load environment variables from the specified file(s)
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Absolute path to resolve files &amp; entry points from. This just changes the process' cwd
+</ParamField>
+
+<ParamField path="--config" type="string">
+  Specify path to Bun config file. Default <code>$cwd/bunfig.toml</code>. Alias: <code>-c</code>
+</ParamField>
+
+## Examples
+
+Run a JavaScript or TypeScript file:
+
+```bash
+bun run ./index.js
+bun run ./index.tsx
+```
+
+Run a package.json script:
+
+```bash
+bun run dev
+bun run lint
+```

package/docs/snippets/cli/test.mdx

@@ -0,0 +1,100 @@
+# CLI Usage
+
+```bash
+bun test <patterns>
+```
+
+### Execution Control
+
+<ParamField path="--timeout" type="number" default="5000">
+  Set the per-test timeout in milliseconds (default 5000)
+</ParamField>
+
+<ParamField path="--rerun-each" type="number">
+  Re-run each test file <code>NUMBER</code> times, helps catch certain bugs
+</ParamField>
+
+<ParamField path="--concurrent" type="boolean">
+  Treat all tests as <code>test.concurrent()</code> tests
+</ParamField>
+
+<ParamField path="--randomize" type="boolean">
+  Run tests in random order
+</ParamField>
+
+<ParamField path="--seed" type="number">
+  Set the random seed for test randomization
+</ParamField>
+
+<ParamField path="--bail" type="number" default="1">
+  Exit the test suite after <code>NUMBER</code> failures. If you do not specify a number, it defaults to 1.
+</ParamField>
+
+<ParamField path="--max-concurrency" type="number" default="20">
+  Maximum number of concurrent tests to execute at once (default 20)
+</ParamField>
+
+### Test Filtering
+
+<ParamField path="--todo" type="boolean">
+  Include tests that are marked with <code>test.todo()</code>
+</ParamField>
+
+<ParamField path="--test-name-pattern" type="string">
+  Run only tests with a name that matches the given regex. Alias: <code>-t</code>
+</ParamField>
+
+### Reporting
+
+<ParamField path="--reporter" type="string">
+  Test output reporter format. Available: <code>junit</code> (requires --reporter-outfile), <code>dots</code>. Default:
+  console output.
+</ParamField>
+
+<ParamField path="--reporter-outfile" type="string">
+  Output file path for the reporter format (required with --reporter)
+</ParamField>
+
+<ParamField path="--dots" type="boolean">
+  Enable dots reporter. Shorthand for --reporter=dots
+</ParamField>
+
+### Coverage
+
+<ParamField path="--coverage" type="boolean">
+  Generate a coverage profile
+</ParamField>
+
+<ParamField path="--coverage-reporter" type="string" default="text">
+  Report coverage in <code>text</code> and/or <code>lcov</code>. Defaults to <code>text</code>
+</ParamField>
+
+<ParamField path="--coverage-dir" type="string" default="coverage">
+  Directory for coverage files. Defaults to <code>coverage</code>
+</ParamField>
+
+### Snapshots
+
+<ParamField path="--update-snapshots" type="boolean">
+  Update snapshot files. Alias: <code>-u</code>
+</ParamField>
+
+## Examples
+
+Run all test files:
+
+```bash terminal icon="terminal"
+bun test
+```
+
+Run all test files with "foo" or "bar" in the file name:
+
+```bash terminal icon="terminal"
+bun test foo bar
+```
+
+Run all test files, only including tests whose names includes "baz":
+
+```bash terminal icon="terminal"
+bun test --test-name-pattern baz
+```

package/docs/snippets/cli/update.mdx

@@ -0,0 +1,144 @@
+## CLI Usage
+
+```bash terminal icon="terminal"
+bun update <package> <version>
+```
+
+### Update Strategy
+
+<ParamField path="--force" type="boolean">
+  Always request the latest versions from the registry &amp; reinstall all dependencies. Alias: <code>-f</code>
+</ParamField>
+
+<ParamField path="--latest" type="boolean">
+  Update packages to their latest versions
+</ParamField>
+
+### Dependency Scope
+
+<ParamField path="--production" type="boolean">
+  Don't install devDependencies. Alias: <code>-p</code>
+</ParamField>
+
+<ParamField path="--global" type="boolean">
+  Install globally. Alias: <code>-g</code>
+</ParamField>
+
+<ParamField path="--omit" type="string">
+  Exclude <code>dev</code>, <code>optional</code>, or <code>peer</code> dependencies from install
+</ParamField>
+
+### Project File Management
+
+<ParamField path="--yarn" type="boolean">
+  Write a <code>yarn.lock</code> file (yarn v1). Alias: <code>-y</code>
+</ParamField>
+
+<ParamField path="--no-save" type="boolean">
+  Don't update <code>package.json</code> or save a lockfile
+</ParamField>
+
+<ParamField path="--save" type="boolean" default="true">
+  Save to <code>package.json</code> (true by default)
+</ParamField>
+
+<ParamField path="--frozen-lockfile" type="boolean">
+  Disallow changes to lockfile
+</ParamField>
+
+<ParamField path="--save-text-lockfile" type="boolean">
+  Save a text-based lockfile
+</ParamField>
+
+<ParamField path="--lockfile-only" type="boolean">
+  Generate a lockfile without installing dependencies
+</ParamField>
+
+### Network & Registry
+
+<ParamField path="--ca" type="string">
+  Provide a Certificate Authority signing certificate
+</ParamField>
+
+<ParamField path="--cafile" type="string">
+  Same as <code>--ca</code>, but as a file path to the certificate
+</ParamField>
+
+<ParamField path="--registry" type="string">
+  Use a specific registry by default, overriding <code>.npmrc</code>, <code>bunfig.toml</code> and environment variables
+</ParamField>
+
+<ParamField path="--network-concurrency" type="number" default="48">
+  Maximum number of concurrent network requests (default 48)
+</ParamField>
+
+### Caching
+
+<ParamField path="--cache-dir" type="string">
+  Store &amp; load cached data from a specific directory path
+</ParamField>
+
+<ParamField path="--no-cache" type="boolean">
+  Ignore manifest cache entirely
+</ParamField>
+
+### Output & Logging
+
+<ParamField path="--silent" type="boolean">
+  Don't log anything
+</ParamField>
+
+<ParamField path="--verbose" type="boolean">
+  Excessively verbose logging
+</ParamField>
+
+<ParamField path="--no-progress" type="boolean">
+  Disable the progress bar
+</ParamField>
+
+<ParamField path="--no-summary" type="boolean">
+  Don't print a summary
+</ParamField>
+
+### Script Execution
+
+<ParamField path="--ignore-scripts" type="boolean">
+  Skip lifecycle scripts in the project's <code>package.json</code> (dependency scripts are never run)
+</ParamField>
+
+<ParamField path="--concurrent-scripts" type="number" default="5">
+  Maximum number of concurrent jobs for lifecycle scripts (default 5)
+</ParamField>
+
+### Installation Controls
+
+<ParamField path="--no-verify" type="boolean">
+  Skip verifying integrity of newly downloaded packages
+</ParamField>
+
+<ParamField path="--trust" type="boolean">
+  Add to <code>trustedDependencies</code> in the project's <code>package.json</code> and install the package(s)
+</ParamField>
+
+<ParamField path="--backend" type="string" default="clonefile">
+  Platform-specific optimizations for installing dependencies. Possible values: <code>clonefile</code> (default),{" "}
+  <code>hardlink</code>, <code>symlink</code>, <code>copyfile</code>
+</ParamField>
+
+### General & Environment
+
+<ParamField path="--config" type="string">
+  Specify path to config file (<code>bunfig.toml</code>). Alias: <code>-c</code>
+</ParamField>
+
+<ParamField path="--dry-run" type="boolean">
+  Don't install anything
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Set a specific cwd
+</ParamField>
+
+<ParamField path="--help" type="boolean">
+  Print this help menu. Alias: <code>-h</code>
+</ParamField>

package/docs/snippets/product-card.mdx

@@ -0,0 +1,32 @@
+export const ProductCard = ({ img, href, title, description, model, type }) => {
+  return (
+    <a href={href} target="_blank" rel="noopener noreferrer" className="group">
+      <div className="flex flex-col gap-4 rounded-xl md:p-1">
+        <div className="w-full h-32 overflow-hidden rounded-xl bg-gray-100 dark:bg-gray-800">
+          <img
+            src={img}
+            className="w-full h-full object-cover transition-transform duration-300 group-hover:scale-105"
+            alt={title}
+            loading="lazy"
+          />
+        </div>
+        <div className="flex flex-col gap-3 pb-2">
+          <h2 className="text-md font-medium text-gray-900 dark:text-gray-200 group-hover:text-gray-600 dark:group-hover:text-gray-400 transition-colors mb-[-8px]">
+            {title}
+          </h2>
+          <p className="text-gray-500 dark:text-gray-400 text-sm font-medium">{description}</p>
+          <div className="flex gap-2 mt-2 mb-1">
+            <span className="bg-gray-100 dark:bg-[#181817] text-gray-600 dark:text-white rounded-lg px-2 py-1 text-sm font-medium">
+              {model}
+            </span>
+            <span className="bg-primary-light dark:bg-primary-dark text-white dark:text-white rounded-lg px-2 py-1 text-sm font-medium">
+              {type}
+            </span>
+          </div>
+        </div>
+      </div>
+    </a>
+  );
+};
+
+;

package/docs/snippets/product-tiles.mdx

@@ -0,0 +1,94 @@
+export const ProductTiles = ({ categories, hideButtons = false }) => {
+  const [activeCategory, setActiveCategory] = useState(categories[0].id)
+  const [activeSubTab, setActiveSubTab] = useState(
+    categories[0].items[0]?.id ?? null
+  )
+
+const currentCategory = categories.find((cat) => cat.id === activeCategory)
+const currentSub = currentCategory?.items.find(
+(item) => item.id === activeSubTab
+)
+
+return (
+
+<div className="not-prose space-y-6">
+{!hideButtons && (
+<div className="flex flex-wrap gap-2">
+{categories.map((cat) => (
+<button
+key={cat.id}
+onClick={() => {
+setActiveCategory(cat.id)
+setActiveSubTab(cat.items[0]?.id ?? null)
+}}
+className={`px-4 py-2 text-sm rounded-full font-medium transition-colors ${activeCategory === cat.id
+              ? 'bg-[#0A0B0D] text-white dark:bg-white dark:text-[#0A0B0D] border-black'
+              : 'bg-gray-100 dark:bg-white/10 text-black dark:text-white'
+              }`} >
+{cat.label}
+</button>
+))}
+</div>
+)}
+
+      <div>
+        {currentCategory?.items?.length ? (
+          <div className="flex flex-col lg:flex-row gap-6 bg-gray-100 dark:bg-[#141414] rounded-2xl">
+            <div className="flex flex-col w-full lg:w-1/2 space-y-2 p-4">
+              {currentCategory.items.map((item) => (
+                <a
+                  key={item.id}
+                  href={item.href}
+                  onMouseOver={() => setActiveSubTab(item.id)}
+                  className={`flex items-start gap-1.5 text-left px-5 py-3 rounded-2xl transition-all ${activeSubTab === item.id
+                    ? 'bg-white dark:bg-white/5'
+                    : ''
+                    }`}
+                >
+                  <div className="text-xl mr-3 mt-1"><img src={item.icon} alt={item.title} className="w-8 h-8" /></div>
+                  <div className="flex-1">
+                    <h3 className="font-medium text-base text-black dark:text-white">
+                      {item.title}
+                    </h3>
+                    <p className="text-sm text-gray-600 dark:text-gray-400">{item.desc}</p>
+                  </div>
+                  <div className={`flex items-center justify-center min-w-[24px] self-center ${activeSubTab === item.id ? 'opacity-100' : 'opacity-0'}`}>
+                    <div className="hidden dark:block">
+                      <Icon icon="chevron-right" size="14" color="#FFF" />
+                    </div>
+                    <div className="block dark:hidden">
+                      <Icon icon="chevron-right" size="14" color="#0A0B0D" />
+                    </div>
+                  </div>
+                </a>
+              ))}
+            </div>
+            <div className="group w-full h-fit lg:w-1/2 rounded-2xl flex items-center justify-center  overflow-hidden min-h-[320px] p-4">
+              {currentSub?.image ? (
+              <>
+                <img
+                  src={currentSub.image.light}
+                  alt={currentSub.title}
+                  className="block dark:hidden w-full h-full object-cover rounded-xl"
+                />
+                <img
+                  src={currentSub.image.dark}
+                  alt={currentSub.title}
+                  className="hidden dark:block w-full h-full object-cover rounded-xl"
+                />
+              </>
+              ) : (
+                <p className="text-gray-400 dark:text-gray-500 p-8">No preview available</p>
+              )}
+            </div>
+          </div>
+        ) : (
+          <p className="text-sm text-gray-500 dark:text-gray-400">
+            No features available for this category.
+          </p>
+        )}
+      </div>
+    </div>
+
+)
+}