bun-types 1.3.2-canary.20251105T140650 → 1.3.2

package/docs/snippets/cli/outdated.mdx

@@ -0,0 +1,140 @@
+## CLI Usage
+
+```bash terminal icon="terminal"
+bun outdated <filter>
+```
+
+### General Options
+
+<ParamField path="-c, --config" type="string">
+  Specify path to config file (<code>bunfig.toml</code>)
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Set a specific cwd
+</ParamField>
+
+<ParamField path="-h, --help" type="boolean">
+  Print this help menu
+</ParamField>
+
+<ParamField path="-F, --filter" type="string">
+  Display outdated dependencies for each matching workspace
+</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>
+
+### Dependency Scope & Target
+
+<ParamField path="-p, --production" type="boolean">
+  Don't install devDependencies
+</ParamField>
+
+<ParamField path="--omit" type="string">
+  Exclude <code>dev</code>, <code>optional</code>, or <code>peer</code> dependencies from install
+</ParamField>
+
+<ParamField path="-g, --global" type="boolean">
+  Install globally
+</ParamField>
+
+### Lockfile & Package.json
+
+<ParamField path="-y, --yarn" type="boolean">
+  Write a <code>yarn.lock</code> file (yarn v1)
+</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>
+
+<ParamField path="--trust" type="boolean">
+  Add to <code>trustedDependencies</code> in the project's <code>package.json</code> and install the package(s)
+</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>
+
+### Execution Behavior
+
+<ParamField path="--dry-run" type="boolean">
+  Don't install anything
+</ParamField>
+
+<ParamField path="-f, --force" type="boolean">
+  Always request the latest versions from the registry &amp; reinstall all dependencies
+</ParamField>
+
+<ParamField path="--no-verify" type="boolean">
+  Skip verifying integrity of newly downloaded packages
+</ParamField>
+
+<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="--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="--concurrent-scripts" type="number" default="5">
+  Maximum number of concurrent jobs for lifecycle scripts (default 5)
+</ParamField>

package/docs/snippets/cli/patch.mdx

@@ -0,0 +1,171 @@
+# CLI Usage
+
+```bash
+bun patch <package>@<version>
+```
+
+### Patch Generation
+
+<ParamField path="--commit" type="boolean">
+  Install a package containing modifications in <code>dir</code>
+</ParamField>
+
+<ParamField path="--patches-dir" type="string">
+  The directory to put the patch file in (only if --commit is used)
+</ParamField>
+
+### Dependency Management
+
+<ParamField path="--production" type="boolean">
+  Don't install devDependencies. Alias: <code>-p</code>
+</ParamField>
+
+<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="--trust" type="boolean">
+  Add to <code>trustedDependencies</code> in the project's <code>package.json</code> and install the package(s)
+</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 Files &amp; Lockfiles
+
+<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>
+
+### Installation Control
+
+<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="--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>
+
+### 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>

package/docs/snippets/cli/publish.mdx

@@ -0,0 +1,198 @@
+## CLI Usage
+
+```bash terminal icon="terminal"
+bun publish dist
+```
+
+### Publishing Options
+
+<ParamField path="--access" type="string">
+  The `--access` flag can be used to set the access level of the package being published. The access level can be one of `public` or `restricted`. Unscoped packages are always public, and attempting to publish an unscoped package with `--access restricted` will result in an error.
+
+```sh terminal icon="terminal"
+bun publish --access public
+```
+
+`--access` can also be set in the `publishConfig` field of your `package.json`.
+
+```json package.json icon="file-json"
+{
+  "publishConfig": {
+    "access": "restricted" // [!code ++]
+  }
+}
+```
+
+</ParamField>
+
+<ParamField path="--tag" type="string"  default="latest">
+Set the tag of the package version being published. By default, the tag is `latest`. The initial version of a package is always given the `latest` tag in addition to the specified tag.
+
+```sh terminal icon="terminal"
+bun publish --tag alpha
+```
+
+`--tag` can also be set in the `publishConfig` field of your `package.json`.
+
+```json package.json file="file-json"
+{
+  "publishConfig": {
+    "tag": "next" // [!code ++]
+  }
+}
+```
+
+</ParamField>
+
+<ParamField path="--dry-run=<val>" type="string">
+The `--dry-run` flag can be used to simulate the publish process without actually publishing the package. This is useful for verifying the contents of the published package without actually publishing the package.
+
+```sh
+bun publish --dry-run
+```
+
+</ParamField>
+
+<ParamField path="--gzip-level" type="string" default="9">
+  Specify the level of gzip compression to use when packing the package. Only applies to `bun publish` without a tarball
+  path argument. Values range from `0` to `9` (default is `9`).
+</ParamField>
+
+<ParamField path="--auth-type" type="string" default="web">
+
+If you have 2FA enabled for your npm account, `bun publish` will prompt you for a one-time password. This can be done through a browser or the CLI. The `--auth-type` flag can be used to tell the npm registry which method you prefer. The possible values are `web` and `legacy`, with `web` being the default.
+
+```sh terminal icon="terminal"
+bun publish --auth-type legacy
+...
+This operation requires a one-time password.
+Enter OTP: 123456
+...
+```
+
+</ParamField>
+
+<ParamField path="--otp" type="string" default="web">
+
+Provide a one-time password directly to the CLI. If the password is valid, this will skip the extra prompt for a one-time password before publishing. Example usage:
+
+```sh terminal icon="terminal"
+bun publish --otp 123456
+```
+
+<Note>
+  `bun publish` respects the `NPM_CONFIG_TOKEN` environment variable which can be used when publishing in github actions
+  or automated workflows.
+</Note>
+
+</ParamField>
+
+### Registry Configuration
+
+#### Custom Registry
+
+<ParamField path="--registry" type="string">
+  Specify registry URL, overriding .npmrc and bunfig.toml
+</ParamField>
+
+```bash
+bun publish --registry https://my-private-registry.com
+```
+
+#### SSL Certificates
+
+<ParamField path="--ca" type="string">
+  Provide Certificate Authority signing certificate
+</ParamField>
+
+<ParamField path="--cafile" type="string">
+  Path to Certificate Authority certificate file
+</ParamField>
+
+<CodeGroup>
+```bash Inline Certificate
+bun publish --ca "-----BEGIN CERTIFICATE-----..."
+```
+
+```bash Certificate File
+bun publish --cafile ./ca-cert.pem
+```
+
+</CodeGroup>
+
+### Publishing Options
+
+#### Dependency Management
+
+<ParamField path="-p, --production" type="boolean">
+  Don't install devDependencies
+</ParamField>
+
+<ParamField path="--omit" type="string">
+  Exclude dependency types: `dev`, `optional`, or `peer`
+</ParamField>
+
+<ParamField path="-f, --force" type="boolean">
+  Always request the latest versions from the registry & reinstall all dependencies
+</ParamField>
+
+#### Script Control
+
+<ParamField path="--ignore-scripts" type="boolean">
+  Skip lifecycle scripts during packing and publishing
+</ParamField>
+
+<ParamField path="--trust" type="boolean">
+  Add packages to trustedDependencies and run their scripts
+</ParamField>
+
+<Note>
+  **Lifecycle Scripts** — When providing a pre-built tarball, lifecycle scripts (prepublishOnly, prepack, etc.) are not
+  executed. Scripts only run when Bun packs the package itself.
+</Note>
+
+#### File Management
+
+<ParamField path="--no-save" type="boolean">
+  Don't update package.json or lockfile
+</ParamField>
+
+<ParamField path="--frozen-lockfile" type="boolean">
+  Disallow changes to lockfile
+</ParamField>
+
+<ParamField path="--yarn" type="boolean">
+  Generate yarn.lock file (yarn v1 compatible)
+</ParamField>
+
+#### Performance
+
+<ParamField path="--backend" type="string">
+  Platform optimizations: `clonefile` (default), `hardlink`, `symlink`, or `copyfile`
+</ParamField>
+
+<ParamField path="--network-concurrency" type="number" default="48">
+  Maximum concurrent network requests
+</ParamField>
+
+<ParamField path="--concurrent-scripts" type="number" default="5">
+  Maximum concurrent lifecycle scripts
+</ParamField>
+
+#### Output Control
+
+<ParamField path="--silent" type="boolean">
+  Suppress all output
+</ParamField>
+
+<ParamField path="--verbose" type="boolean">
+  Show detailed logging
+</ParamField>
+
+<ParamField path="--no-progress" type="boolean">
+  Hide progress bar
+</ParamField>
+
+<ParamField path="--no-summary" type="boolean">
+  Don't print publish summary
+</ParamField>

package/docs/snippets/cli/remove.mdx

@@ -0,0 +1,146 @@
+## CLI Usage
+
+```bash terminal icon="terminal"
+bun remove <package>
+```
+
+### General Information
+
+<ParamField path="--help" type="boolean">
+  Print this help menu. Alias: <code>-h</code>
+</ParamField>
+
+### Configuration
+
+<ParamField path="--config" type="string">
+  Specify path to config file (<code>bunfig.toml</code>). Alias: <code>-c</code>
+</ParamField>
+
+### Package.json Interaction
+
+<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>
+
+### Lockfile Behavior
+
+<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>
+
+### Dependency Filtering
+
+<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>
+
+### 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>
+
+### Execution Control & Validation
+
+<ParamField path="--dry-run" type="boolean">
+  Don't install anything
+</ParamField>
+
+<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>
+
+### 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>
+
+### 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>
+
+### 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>
+
+### Scope & Path
+
+<ParamField path="--global" type="boolean">
+  Install globally. Alias: <code>-g</code>
+</ParamField>
+
+<ParamField path="--cwd" type="string">
+  Set a specific cwd
+</ParamField>
+
+### Advanced & Performance
+
+<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="--network-concurrency" type="number" default="48">
+  Maximum number of concurrent network requests (default 48)
+</ParamField>