bun-types 1.3.2-canary.20251106T140813 → 1.3.2

package/docs/snippets/cli/build.mdx

@@ -0,0 +1,196 @@
+## CLI Usage
+
+```bash
+bun build <entry points>
+```
+
+### General Configuration
+
+<ParamField path="--production" type="boolean">
+  Set <code>NODE_ENV=production</code> and enable minification
+</ParamField>
+
+<ParamField path="--bytecode" type="boolean">
+  Use a bytecode cache when compiling
+</ParamField>
+
+<ParamField path="--target" type="string" default="browser">
+  Intended execution environment for the bundle. One of <code>browser</code>, <code>bun</code>, or <code>node</code>
+</ParamField>
+
+<ParamField path="--conditions" type="string">
+  Pass custom resolution conditions
+</ParamField>
+
+<ParamField path="--env" type="string" default="disable">
+  Inline environment variables into the bundle as <code>process.env.${name}</code>. To inline variables matching a
+  prefix, use a glob like <code>FOO_PUBLIC_*</code>
+</ParamField>
+
+### Output & File Handling
+
+<ParamField path="--outdir" type="string" default="dist">
+  Output directory (used when building multiple entry points)
+</ParamField>
+
+<ParamField path="--outfile" type="string">
+  Write output to a specific file
+</ParamField>
+
+<ParamField path="--sourcemap" type="string" default="none">
+  Generate source maps. One of <code>linked</code>, <code>inline</code>, <code>external</code>, or <code>none</code>
+</ParamField>
+
+<ParamField path="--banner" type="string">
+  Add a banner to the output (e.g. <code>"use client"</code> for React Server Components)
+</ParamField>
+
+<ParamField path="--footer" type="string">
+  Add a footer to the output (e.g. <code>// built with bun!</code>)
+</ParamField>
+
+<ParamField path="--format" type="string" default="esm">
+  Module format of the output bundle. One of <code>esm</code>, <code>cjs</code>, or <code>iife</code>
+</ParamField>
+
+### File Naming
+
+<ParamField path="--entry-naming" type="string" default="[dir]/[name].[ext]">
+  Customize entry point filenames
+</ParamField>
+
+<ParamField path="--chunk-naming" type="string" default="[name]-[hash].[ext]">
+  Customize chunk filenames
+</ParamField>
+
+<ParamField path="--asset-naming" type="string" default="[name]-[hash].[ext]">
+  Customize asset filenames
+</ParamField>
+
+### Bundling Options
+
+<ParamField path="--root" type="string">
+  Root directory used when bundling multiple entry points
+</ParamField>
+
+<ParamField path="--splitting" type="boolean">
+  Enable code splitting for shared modules
+</ParamField>
+
+<ParamField path="--public-path" type="string">
+  Prefix to be added to import paths in bundled code
+</ParamField>
+
+<ParamField path="--external" type="string">
+  Exclude modules from the bundle (supports wildcards). Alias: <code>-e</code>
+</ParamField>
+
+<ParamField path="--packages" type="string" default="bundle">
+  How to treat dependencies: <code>external</code> or <code>bundle</code>
+</ParamField>
+
+<ParamField path="--no-bundle" type="boolean">
+  Transpile only — do not bundle
+</ParamField>
+
+<ParamField path="--css-chunking" type="boolean">
+  Chunk CSS files together to reduce duplication (only when multiple entry points import CSS)
+</ParamField>
+
+### Minification & Optimization
+
+<ParamField path="--emit-dce-annotations" type="boolean" default="true">
+  Re-emit Dead Code Elimination annotations. Disabled when <code>--minify-whitespace</code> is used
+</ParamField>
+
+<ParamField path="--minify" type="boolean">
+  Enable all minification options
+</ParamField>
+
+<ParamField path="--minify-syntax" type="boolean">
+  Minify syntax and inline constants
+</ParamField>
+
+<ParamField path="--minify-whitespace" type="boolean">
+  Minify whitespace
+</ParamField>
+
+<ParamField path="--minify-identifiers" type="boolean">
+  Minify variable and function identifiers
+</ParamField>
+
+<ParamField path="--keep-names" type="boolean">
+  Preserve original function and class names when minifying
+</ParamField>
+
+### Development Features
+
+<ParamField path="--watch" type="boolean">
+  Rebuild automatically when files change
+</ParamField>
+
+<ParamField path="--no-clear-screen" type="boolean">
+  Don’t clear the terminal when rebuilding with <code>--watch</code>
+</ParamField>
+
+<ParamField path="--react-fast-refresh" type="boolean">
+  Enable React Fast Refresh transform (for development testing)
+</ParamField>
+
+### Standalone Executables
+
+<ParamField path="--compile" type="boolean">
+  Generate a standalone Bun executable containing the bundle. Implies <code>--production</code>
+</ParamField>
+
+<ParamField path="--compile-exec-argv" type="string">
+  Prepend arguments to the standalone executable’s <code>execArgv</code>
+</ParamField>
+
+### Windows Executable Details
+
+<ParamField path="--windows-hide-console" type="boolean">
+  Prevent a console window from opening when running a compiled Windows executable
+</ParamField>
+
+<ParamField path="--windows-icon" type="string">
+  Set an icon for the Windows executable
+</ParamField>
+
+<ParamField path="--windows-title" type="string">
+  Set the Windows executable product name
+</ParamField>
+
+<ParamField path="--windows-publisher" type="string">
+  Set the Windows executable company name
+</ParamField>
+
+<ParamField path="--windows-version" type="string">
+  Set the Windows executable version (e.g. <code>1.2.3.4</code>)
+</ParamField>
+
+<ParamField path="--windows-description" type="string">
+  Set the Windows executable description
+</ParamField>
+
+<ParamField path="--windows-copyright" type="string">
+  Set the Windows executable copyright notice
+</ParamField>
+
+### Experimental & App Building
+
+<ParamField path="--app" type="boolean">
+  <b>(EXPERIMENTAL)</b> Build a web app for production using Bun Bake
+</ParamField>
+
+<ParamField path="--server-components" type="boolean">
+  <b>(EXPERIMENTAL)</b> Enable React Server Components
+</ParamField>
+
+<ParamField path="--debug-dump-server-files" type="boolean">
+  When <code>--app</code> is set, dump all server files to disk even for static builds
+</ParamField>
+
+<ParamField path="--debug-no-minify" type="boolean">
+  When <code>--app</code> is set, disable all minification
+</ParamField>

package/docs/snippets/cli/feedback.mdx

@@ -0,0 +1,17 @@
+## CLI Usage
+
+```bash
+bun feedback [options] [feedback text ... | files ...]
+```
+
+### Contact Information
+
+<ParamField path="--email" type="string">
+  Set the email address used for this submission. Alias: <code>-e</code>
+</ParamField>
+
+### Help
+
+<ParamField path="--help" type="boolean">
+  Show this help message and exit. Alias: <code>-h</code>
+</ParamField>

package/docs/snippets/cli/init.mdx

@@ -0,0 +1,84 @@
+## CLI Usage
+
+```bash terminal icon="terminal"
+bun init <folder?>
+```
+
+### Initialization Options
+
+<ParamField path="--yes" type="boolean">
+  {" "}
+  Accept all default prompts without asking questions. Alias: <code>-y</code>{" "}
+</ParamField>
+<ParamField path="--minimal" type="boolean">
+  {" "}
+  Only initialize type definitions (skip app scaffolding). Alias: <code>-m</code>{" "}
+</ParamField>
+
+### Project Templates
+
+<ParamField path="--react" type="string|boolean">
+  {" "}
+  Scaffold a React project. When used without a value, creates a baseline React app.
+  <br /> Accepts values for presets:{" "}
+  <ul>
+    {" "}
+    <li>
+      <code>tailwind</code> – React app preconfigured with Tailwind CSS
+    </li>{" "}
+    <li>
+      <code>shadcn</code> – React app with <code>@shadcn/ui</code> and Tailwind CSS
+    </li>{" "}
+  </ul>{" "}
+  Examples:{" "}
+  <pre>
+    <code>bun init --react bun init --react=tailwind bun init --react=shadcn</code>
+  </pre>{" "}
+</ParamField>
+
+### Output & Files
+
+<ParamField path="(result)" type="info">
+  {" "}
+  Initializes project files and configuration for the chosen options (e.g., creating essential config files and a
+  starter directory structure). Exact files vary by template.{" "}
+</ParamField>
+
+### Global Configuration & Context
+
+<ParamField path="--cwd" type="string">
+  {" "}
+  Run <code>bun init</code> as if started in a different working directory (useful in scripts).{" "}
+</ParamField>
+
+### Help
+
+<ParamField path="--help" type="boolean">
+  {" "}
+  Print this help menu. Alias: <code>-h</code>{" "}
+</ParamField>
+
+### Examples
+
+- Accept all defaults
+
+  ```bash terminal icon="terminal"
+  bun init -y
+  ```
+
+- React
+
+  ```bash terminal icon="terminal"
+  bun init --react
+  ```
+
+- React + Tailwind CSS
+
+  ```bash terminal icon="terminal"
+  bun init --react=tailwind
+  ```
+
+- React + @shadcn/ui
+  ```bash terminal icon="terminal"
+  bun init --react=shadcn
+  ```

package/docs/snippets/cli/install.mdx

@@ -0,0 +1,173 @@
+## CLI Usage
+
+```sh terminal icon="terminal"
+bun install <name>@<version>
+```
+
+### General Configuration
+
+<ParamField path="--config" type="string">
+  Specify path to config file (bunfig.toml)
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Set a specific cwd
+</ParamField>
+
+### Dependency Scope & Management
+
+<ParamField path="--production" type="boolean">
+  Don't install devDependencies
+</ParamField>
+
+<ParamField path="--no-save" type="boolean">
+  Don't update package.json or save a lockfile
+</ParamField>
+
+<ParamField path="--save" type="boolean" default="true">
+  Save to package.json
+</ParamField>
+
+<ParamField path="--omit" type="string">
+  Exclude 'dev', 'optional', or 'peer' dependencies from install
+</ParamField>
+
+<ParamField path="--only-missing" type="boolean">
+  Only add dependencies to package.json if they are not already present
+</ParamField>
+
+### Dependency Type & Versioning
+
+<ParamField path="--dev" type="boolean">
+  Add dependency to "devDependencies"
+</ParamField>
+
+<ParamField path="--optional" type="boolean">
+  Add dependency to "optionalDependencies"
+</ParamField>
+
+<ParamField path="--peer" type="boolean">
+  Add dependency to "peerDependencies"
+</ParamField>
+
+<ParamField path="--exact" type="boolean">
+  Add the exact version instead of the ^range
+</ParamField>
+
+### Lockfile Control
+
+<ParamField path="--yarn" type="boolean">
+  Write a yarn.lock file (yarn v1)
+</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 Settings
+
+<ParamField path="--ca" type="string">
+  Provide a Certificate Authority signing certificate
+</ParamField>
+
+<ParamField path="--cafile" type="string">
+  File path to Certificate Authority signing certificate
+</ParamField>
+
+<ParamField path="--registry" type="string">
+  Use a specific registry by default, overriding .npmrc, bunfig.toml and environment variables
+</ParamField>
+
+### Installation Process Control
+
+<ParamField path="--dry-run" type="boolean">
+  Don't install anything
+</ParamField>
+
+<ParamField path="--force" type="boolean">
+  Always request the latest versions from the registry & reinstall all dependencies
+</ParamField>
+
+<ParamField path="--global" type="boolean">
+  Install globally
+</ParamField>
+
+<ParamField path="--backend" type="string" default="clonefile">
+  Platform-specific optimizations: "clonefile", "hardlink", "symlink", "copyfile"
+</ParamField>
+
+<ParamField path="--filter" type="string">
+  Install packages for the matching workspaces
+</ParamField>
+
+<ParamField path="--analyze" type="boolean">
+  Analyze & install all dependencies of files passed as arguments recursively
+</ParamField>
+
+### Caching Options
+
+<ParamField path="--cache-dir" type="string">
+  Store & 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>
+
+### Security & Integrity
+
+<ParamField path="--no-verify" type="boolean">
+  Skip verifying integrity of newly downloaded packages
+</ParamField>
+
+<ParamField path="--trust" type="boolean">
+  Add to trustedDependencies in the project's package.json and install the package(s)
+</ParamField>
+
+### Concurrency & Performance
+
+<ParamField path="--concurrent-scripts" type="number" default="5">
+  Maximum number of concurrent jobs for lifecycle scripts
+</ParamField>
+
+<ParamField path="--network-concurrency" type="number" default="48">
+  Maximum number of concurrent network requests
+</ParamField>
+
+### Lifecycle Script Management
+
+<ParamField path="--ignore-scripts" type="boolean">
+  Skip lifecycle scripts in the project's package.json (dependency scripts are never run)
+</ParamField>
+
+### Help Information
+
+<ParamField path="--help" type="boolean">
+  Print this help menu
+</ParamField>

package/docs/snippets/cli/link.mdx

@@ -0,0 +1,163 @@
+# CLI Usage
+
+```bash
+bun link <packages>
+```
+
+### Installation Scope
+
+<ParamField path="--global" type="boolean">
+  Install globally. Alias: <code>-g</code>
+</ParamField>
+
+### Dependency Management
+
+<ParamField path="--production" type="boolean">
+  Don't install devDependencies. Alias: <code>-p</code>
+</ParamField>
+
+<ParamField path="--omit" type="string">
+  Exclude <code>dev</code>, <code>optional</code>, or <code>peer</code> dependencies from install
+</ParamField>
+
+### Project Files &amp; Lockfiles
+
+<ParamField path="--yarn" type="boolean">
+  Write a <code>yarn.lock</code> file (yarn v1). Alias: <code>-y</code>
+</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>
+
+<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="--trust" type="boolean">
+  Add to <code>trustedDependencies</code> in the project's <code>package.json</code> and install the package(s)
+</ParamField>
+
+### Installation Control
+
+<ParamField path="--force" type="boolean">
+  Always request the latest versions from the registry &amp; reinstall all dependencies. Alias: <code>-f</code>
+</ParamField>
+
+<ParamField path="--no-verify" type="boolean">
+  Skip verifying integrity of newly downloaded packages
+</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>
+
+<ParamField path="--linker" type="string">
+  Linker strategy (one of <code>isolated</code> or <code>hoisted</code>)
+</ParamField>
+
+<ParamField path="--dry-run" type="boolean">
+  Don't install anything
+</ParamField>
+
+<ParamField path="--ignore-scripts" type="boolean">
+  Skip lifecycle scripts in the project's <code>package.json</code> (dependency scripts are never run)
+</ParamField>
+
+### Network &amp; 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>
+
+### Performance &amp; Resource
+
+<ParamField path="--concurrent-scripts" type="number" default="5">
+  Maximum number of concurrent jobs for lifecycle scripts (default 5)
+</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 &amp; Logging
+
+<ParamField path="--silent" type="boolean">
+  Don't log anything
+</ParamField>
+
+<ParamField path="--quiet" type="boolean">
+  Only show tarball name when packing
+</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>
+
+### Platform Targeting
+
+<ParamField path="--cpu" type="string">
+  Override CPU architecture for optional dependencies (e.g., <code>x64</code>, <code>arm64</code>, <code>*</code> for
+  all)
+</ParamField>
+
+<ParamField path="--os" type="string">
+  Override operating system for optional dependencies (e.g., <code>linux</code>, <code>darwin</code>, <code>*</code> for
+  all)
+</ParamField>
+
+### Global Configuration &amp; Context
+
+<ParamField path="--config" type="string">
+  Specify path to config file (<code>bunfig.toml</code>). Alias: <code>-c</code>
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Set a specific current working directory
+</ParamField>
+
+### Help
+
+<ParamField path="--help" type="boolean">
+  Print this help menu. Alias: <code>-h</code>
+</ParamField>