bun-types 1.3.2-canary.20251104T140728 → 1.3.2-canary.20251106T140813

package/docs/cli/init.md

@@ -1,85 +0,0 @@
-Scaffold an empty Bun project with the interactive `bun init` command.
-
-```bash
-$ bun init
-
-? Select a project template - Press return to submit.
-❯ Blank
-  React
-  Library
-
-✓ Select a project template: Blank
-
-+ .gitignore
-+ index.ts
-+ tsconfig.json (for editor autocomplete)
-+ README.md
-
-To get started, run:
-
-    bun run index.ts
-
-bun install v1.3.2-canary.20251104T140728
-
-+ @types/bun@1.3.2-canary.20251104T140728
-+ typescript@5.9.2
-
-7 packages installed
-```
-
-Press `enter` to accept the default answer for each prompt, or pass the `-y` flag to auto-accept the defaults.
-
-{% details summary="How `bun init` works" %}
-
-`bun init` is a quick way to start a blank project with Bun. It guesses with sane defaults and is non-destructive when run multiple times.
-
-![Demo](https://user-images.githubusercontent.com/709451/183006613-271960a3-ff22-4f7c-83f5-5e18f684c836.gif)
-
-It creates:
-
-- a `package.json` file with a name that defaults to the current directory name
-- a `tsconfig.json` file or a `jsconfig.json` file, depending if the entry point is a TypeScript file or not
-- an entry point which defaults to `index.ts` unless any of `index.{tsx, jsx, js, mts, mjs}` exist or the `package.json` specifies a `module` or `main` field
-- a `README.md` file
-
-AI Agent rules (disable with `$BUN_AGENT_RULE_DISABLED=1`):
-
-- a `CLAUDE.md` file when Claude CLI is detected (disable with `CLAUDE_CODE_AGENT_RULE_DISABLED` env var)
-- a `.cursor/rules/*.mdc` file to guide [Cursor AI](https://cursor.sh) to use Bun instead of Node.js and npm when Cursor is detected
-
-If you pass `-y` or `--yes`, it will assume you want to continue without asking questions.
-
-At the end, it runs `bun install` to install `@types/bun`.
-
-{% /details %}
-
-{% bunCLIUsage command="init" /%}
-
-## React
-
-The `--react` flag will scaffold a React project:
-
-```bash
-$ bun init --react
-```
-
-The `--react` flag accepts the following values:
-
-- `tailwind` - Scaffold a React project with Tailwind CSS
-- `shadcn` - Scaffold a React project with Shadcn/UI and Tailwind CSS
-
-### React + TailwindCSS
-
-This will create a React project with Tailwind CSS configured with Bun's bundler and dev server.
-
-```bash
-$ bun init --react=tailwind
-```
-
-### React + @shadcn/ui
-
-This will create a React project with shadcn/ui and Tailwind CSS configured with Bun's bundler and dev server.
-
-```bash
-$ bun init --react=shadcn
-```

package/docs/cli/install.md

@@ -1,344 +0,0 @@
-The `bun` CLI contains a Node.js-compatible package manager designed to be a dramatically faster replacement for `npm`, `yarn`, and `pnpm`. It's a standalone tool that will work in pre-existing Node.js projects; if your project has a `package.json`, `bun install` can help you speed up your workflow.
-
-{% callout %}
-
-**⚡️ 25x faster** — Switch from `npm install` to `bun install` in any Node.js project to make your installations up to 25x faster.
-
-{% image src="https://user-images.githubusercontent.com/709451/147004342-571b6123-17a9-49a2-8bfd-dcfc5204047e.png" height="200" /%}
-
-{% /callout %}
-
-{% callout %}
-
-**💾 Disk efficient** — Bun install stores all packages in a global cache (`~/.bun/install/cache/`) and creates hardlinks (Linux) or copy-on-write clones (macOS) to `node_modules`. This means duplicate packages across projects point to the same underlying data, taking up virtually no extra disk space.
-
-For more details, see [Package manager > Global cache](https://bun.com/docs/install/cache).
-
-{% /callout %}
-
-{% details summary="For Linux users" %}
-The recommended minimum Linux Kernel version is 5.6. If you're on Linux kernel 5.1 - 5.5, `bun install` will work, but HTTP requests will be slow due to a lack of support for io_uring's `connect()` operation.
-
-If you're using Ubuntu 20.04, here's how to install a [newer kernel](https://wiki.ubuntu.com/Kernel/LTSEnablementStack):
-
-```bash
-# If this returns a version >= 5.6, you don't need to do anything
-$ uname -r
-
-# Install the official Ubuntu hardware enablement kernel
-$ sudo apt install --install-recommends linux-generic-hwe-20.04
-```
-
-{% /details %}
-
-To install all dependencies of a project:
-
-```bash
-$ bun install
-```
-
-Running `bun install` will:
-
-- **Install** all `dependencies`, `devDependencies`, and `optionalDependencies`. Bun will install `peerDependencies` by default.
-- **Run** your project's `{pre|post}install` and `{pre|post}prepare` scripts at the appropriate time. For security reasons Bun _does not execute_ lifecycle scripts of installed dependencies.
-- **Write** a `bun.lock` lockfile to the project root.
-
-## Logging
-
-To modify logging verbosity:
-
-```bash
-$ bun install --verbose # debug logging
-$ bun install --silent  # no logging
-```
-
-## Lifecycle scripts
-
-Unlike other npm clients, Bun does not execute arbitrary lifecycle scripts like `postinstall` for installed dependencies. Executing arbitrary scripts represents a potential security risk.
-
-To tell Bun to allow lifecycle scripts for a particular package, add the package to `trustedDependencies` in your package.json.
-
-```json-diff
-  {
-    "name": "my-app",
-    "version": "1.0.0",
-+   "trustedDependencies": ["my-trusted-package"]
-  }
-```
-
-Then re-install the package. Bun will read this field and run lifecycle scripts for `my-trusted-package`.
-
-Lifecycle scripts will run in parallel during installation. To adjust the maximum number of concurrent scripts, use the `--concurrent-scripts` flag. The default is two times the reported cpu count or GOMAXPROCS.
-
-```bash
-$ bun install --concurrent-scripts 5
-```
-
-## Workspaces
-
-Bun supports `"workspaces"` in package.json. For complete documentation refer to [Package manager > Workspaces](https://bun.com/docs/install/workspaces).
-
-```json#package.json
-{
-  "name": "my-app",
-  "version": "1.0.0",
-  "workspaces": ["packages/*"],
-  "dependencies": {
-    "preact": "^10.5.13"
-  }
-}
-```
-
-## Installing dependencies for specific packages
-
-In a monorepo, you can install the dependencies for a subset of packages using the `--filter` flag.
-
-```bash
-# Install dependencies for all workspaces except `pkg-c`
-$ bun install --filter '!pkg-c'
-
-# Install dependencies for only `pkg-a` in `./packages/pkg-a`
-$ bun install --filter './packages/pkg-a'
-```
-
-For more information on filtering with `bun install`, refer to [Package Manager > Filtering](https://bun.com/docs/cli/filter#bun-install-and-bun-outdated)
-
-## Overrides and resolutions
-
-Bun supports npm's `"overrides"` and Yarn's `"resolutions"` in `package.json`. These are mechanisms for specifying a version range for _metadependencies_—the dependencies of your dependencies. Refer to [Package manager > Overrides and resolutions](https://bun.com/docs/install/overrides) for complete documentation.
-
-```json-diff#package.json
-  {
-    "name": "my-app",
-    "dependencies": {
-      "foo": "^2.0.0"
-    },
-+   "overrides": {
-+     "bar": "~4.4.0"
-+   }
-  }
-```
-
-## Global packages
-
-To install a package globally, use the `-g`/`--global` flag. Typically this is used for installing command-line tools.
-
-```bash
-$ bun install --global cowsay # or `bun install -g cowsay`
-$ cowsay "Bun!"
- ______
-< Bun! >
- ------
-        \   ^__^
-         \  (oo)\_______
-            (__)\       )\/\
-                ||----w |
-                ||     ||
-```
-
-## Production mode
-
-To install in production mode (i.e. without `devDependencies` or `optionalDependencies`):
-
-```bash
-$ bun install --production
-```
-
-For reproducible installs, use `--frozen-lockfile`. This will install the exact versions of each package specified in the lockfile. If your `package.json` disagrees with `bun.lock`, Bun will exit with an error. The lockfile will not be updated.
-
-```bash
-$ bun install --frozen-lockfile
-```
-
-For more information on Bun's lockfile `bun.lock`, refer to [Package manager > Lockfile](https://bun.com/docs/install/lockfile).
-
-## Omitting dependencies
-
-To omit dev, peer, or optional dependencies use the `--omit` flag.
-
-```bash
-# Exclude "devDependencies" from the installation. This will apply to the
-# root package and workspaces if they exist. Transitive dependencies will
-# not have "devDependencies".
-$ bun install --omit dev
-
-# Install only dependencies from "dependencies"
-$ bun install --omit=dev --omit=peer --omit=optional
-```
-
-## Dry run
-
-To perform a dry run (i.e. don't actually install anything):
-
-```bash
-$ bun install --dry-run
-```
-
-## Non-npm dependencies
-
-Bun supports installing dependencies from Git, GitHub, and local or remotely-hosted tarballs. For complete documentation refer to [Package manager > Git, GitHub, and tarball dependencies](https://bun.com/docs/cli/add).
-
-```json#package.json
-{
-  "dependencies": {
-    "dayjs": "git+https://github.com/iamkun/dayjs.git",
-    "lodash": "git+ssh://github.com/lodash/lodash.git#4.17.21",
-    "moment": "git@github.com:moment/moment.git",
-    "zod": "github:colinhacks/zod",
-    "react": "https://registry.npmjs.org/react/-/react-18.2.0.tgz",
-    "bun-types": "npm:@types/bun"
-  }
-}
-```
-
-## Installation strategies
-
-Bun supports two package installation strategies that determine how dependencies are organized in `node_modules`:
-
-### Hoisted installs (default for single projects)
-
-The traditional npm/Yarn approach that flattens dependencies into a shared `node_modules` directory:
-
-```bash
-$ bun install --linker hoisted
-```
-
-### Isolated installs
-
-A pnpm-like approach that creates strict dependency isolation to prevent phantom dependencies:
-
-```bash
-$ bun install --linker isolated
-```
-
-Isolated installs create a central package store in `node_modules/.bun/` with symlinks in the top-level `node_modules`. This ensures packages can only access their declared dependencies.
-
-For complete documentation on isolated installs, refer to [Package manager > Isolated installs](https://bun.com/docs/install/isolated).
-
-## Disk efficiency
-
-Bun uses a global cache at `~/.bun/install/cache/` to minimize disk usage. Packages are stored once and linked to `node_modules` using hardlinks (Linux/Windows) or copy-on-write (macOS), so duplicate packages across projects don't consume additional disk space.
-
-For complete documentation refer to [Package manager > Global cache](https://bun.com/docs/install/cache).
-
-## Minimum release age
-
-To protect against supply chain attacks where malicious packages are quickly published, you can configure a minimum age requirement for npm packages. Package versions published more recently than the specified threshold (in seconds) will be filtered out during installation.
-
-```bash
-# Only install package versions published at least 3 days ago
-$ bun add @types/bun --minimum-release-age 259200 # seconds
-```
-
-You can also configure this in `bunfig.toml`:
-
-```toml
-[install]
-# Only install package versions published at least 3 days ago
-minimumReleaseAge = 259200 # seconds
-
-# Exclude trusted packages from the age gate
-minimumReleaseAgeExcludes = ["@types/node", "typescript"]
-```
-
-When the minimum age filter is active:
-
-- Only affects new package resolution - existing packages in `bun.lock` remain unchanged
-- All dependencies (direct and transitive) are filtered to meet the age requirement when being resolved
-- When versions are blocked by the age gate, a stability check detects rapid bugfix patterns
-  - If multiple versions were published close together just outside your age gate, it extends the filter to skip those potentially unstable versions and selects an older, more mature version
-  - Searches up to 7 days after the age gate, however if still finding rapid releases it ignores stability check
-  - Exact version requests (like `package@1.1.1`) still respect the age gate but bypass the stability check
-- Versions without a `time` field are treated as passing the age check (npm registry should always provide timestamps)
-
-For more advanced security scanning, including integration with services & custom filtering, see [Package manager > Security Scanner API](https://bun.com/docs/install/security-scanner-api).
-
-## Configuration
-
-The default behavior of `bun install` can be configured in `bunfig.toml`. The default values are shown below.
-
-```toml
-[install]
-
-# whether to install optionalDependencies
-optional = true
-
-# whether to install devDependencies
-dev = true
-
-# whether to install peerDependencies
-peer = true
-
-# equivalent to `--production` flag
-production = false
-
-# equivalent to `--save-text-lockfile` flag
-saveTextLockfile = false
-
-# equivalent to `--frozen-lockfile` flag
-frozenLockfile = false
-
-# equivalent to `--dry-run` flag
-dryRun = false
-
-# equivalent to `--concurrent-scripts` flag
-concurrentScripts = 16 # (cpu count or GOMAXPROCS) x2
-
-# installation strategy: "hoisted" or "isolated"
-# default: "hoisted"
-linker = "hoisted"
-
-# minimum age config
-minimumReleaseAge = 259200 # seconds
-minimumReleaseAgeExcludes = ["@types/node", "typescript"]
-```
-
-## CI/CD
-
-Use the official [`oven-sh/setup-bun`](https://github.com/oven-sh/setup-bun) action to install `bun` in a GitHub Actions pipeline:
-
-```yaml#.github/workflows/release.yml
-name: bun-types
-jobs:
-  build:
-    name: build-app
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-      - name: Install bun
-        uses: oven-sh/setup-bun@v2
-      - name: Install dependencies
-        run: bun install
-      - name: Build app
-        run: bun run build
-```
-
-For CI/CD environments that want to enforce reproducible builds, use `bun ci` to fail the build if the package.json is out of sync with the lockfile:
-
-```bash
-$ bun ci
-```
-
-This is equivalent to `bun install --frozen-lockfile`. It installs exact versions from `bun.lock` and fails if `package.json` doesn't match the lockfile. To use `bun ci` or `bun install --frozen-lockfile`, you must commit `bun.lock` to version control.
-
-And instead of running `bun install`, run `bun ci`.
-
-```yaml#.github/workflows/release.yml
-name: bun-types
-jobs:
-  build:
-    name: build-app
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-      - name: Install bun
-        uses: oven-sh/setup-bun@v2
-      - name: Install dependencies
-        run: bun ci
-      - name: Build app
-        run: bun run build
-```
-
-{% bunCLIUsage command="install" /%}

package/docs/cli/link.md

@@ -1,40 +0,0 @@
-Use `bun link` in a local directory to register the current package as a "linkable" package.
-
-```bash
-$ cd /path/to/cool-pkg
-$ cat package.json
-{
-  "name": "cool-pkg",
-  "version": "1.0.0"
-}
-$ bun link
-bun link v1.x (7416672e)
-Success! Registered "cool-pkg"
-
-To use cool-pkg in a project, run:
-  bun link cool-pkg
-
-Or add it in dependencies in your package.json file:
-  "cool-pkg": "link:cool-pkg"
-```
-
-This package can now be "linked" into other projects using `bun link cool-pkg`. This will create a symlink in the `node_modules` directory of the target project, pointing to the local directory.
-
-```bash
-$ cd /path/to/my-app
-$ bun link cool-pkg
-```
-
-In addition, the `--save` flag can be used to add `cool-pkg` to the `dependencies` field of your app's package.json with a special version specifier that tells Bun to load from the registered local directory instead of installing from `npm`:
-
-```json-diff
-  {
-    "name": "my-app",
-    "version": "1.0.0",
-    "dependencies": {
-+     "cool-pkg": "link:cool-pkg"
-    }
-  }
-```
-
-{% bunCLIUsage command="link" /%}

package/docs/cli/outdated.md

@@ -1,90 +0,0 @@
-Use `bun outdated` to check for outdated dependencies in your project. This command displays a table of dependencies that have newer versions available.
-
-{% bunOutdatedTerminal displayGlob="" filter="" glob="" /%}
-
-## Version Information
-
-The output table shows three version columns:
-
-- **Current**: The version currently installed
-- **Update**: The latest version that satisfies your package.json version range
-- **Latest**: The latest version published to the registry
-
-### Dependency Filters
-
-`bun outdated` supports searching for outdated dependencies by package names and glob patterns.
-
-To check if specific dependencies are outdated, pass the package names as positional arguments:
-
-{% bunOutdatedTerminal displayGlob="eslint-plugin-security eslint-plugin-sonarjs" glob="eslint-plugin-*"  /%}
-
-You can also pass glob patterns to check for outdated packages:
-
-{% bunOutdatedTerminal displayGlob="'eslint*'" glob="eslint*"  /%}
-
-For example, to check for outdated `@types/*` packages:
-
-{% bunOutdatedTerminal displayGlob="'@types/*'" glob="@types/*"  /%}
-
-Or to exclude all `@types/*` packages:
-
-{% bunOutdatedTerminal displayGlob="'!@types/*'" glob="!@types/*"  /%}
-
-### Workspace Filters
-
-Use the `--filter` flag to check for outdated dependencies in a different workspace package:
-
-{% bunOutdatedTerminal  glob="t*" filter="@monorepo/types"  /%}
-
-You can pass multiple `--filter` flags to check multiple workspaces:
-
-{% bunOutdatedTerminal  glob="{e,t}*" displayGlob="--filter @monorepo/types --filter @monorepo/cli" /%}
-
-You can also pass glob patterns to filter by workspace names:
-
-{% bunOutdatedTerminal  glob="{e,t}*" displayGlob="--filter='@monorepo/{types,cli}'" /%}
-
-### Catalog Dependencies
-
-`bun outdated` supports checking catalog dependencies defined in `package.json`:
-
-```sh
-$ bun outdated -r
-┌────────────────────┬─────────┬─────────┬─────────┬────────────────────────────────┐
-│ Package            │ Current │ Update  │ Latest  │ Workspace                      │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ body-parser        │ 1.19.0  │ 1.19.0  │ 2.2.0   │ @test/shared                   │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ cors               │ 2.8.0   │ 2.8.0   │ 2.8.5   │ @test/shared                   │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ chalk              │ 4.0.0   │ 4.0.0   │ 5.6.2   │ @test/utils                    │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ uuid               │ 8.0.0   │ 8.0.0   │ 13.0.0  │ @test/utils                    │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ axios              │ 0.21.0  │ 0.21.0  │ 1.12.2  │ catalog (@test/app)            │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ lodash             │ 4.17.15 │ 4.17.15 │ 4.17.21 │ catalog (@test/app, @test/app) │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ react              │ 17.0.0  │ 17.0.0  │ 19.1.1  │ catalog (@test/app)            │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ react-dom          │ 17.0.0  │ 17.0.0  │ 19.1.1  │ catalog (@test/app)            │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ express            │ 4.17.0  │ 4.17.0  │ 5.1.0   │ catalog (@test/shared)         │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ moment             │ 2.24.0  │ 2.24.0  │ 2.30.1  │ catalog (@test/utils)          │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ @types/node (dev)  │ 14.0.0  │ 14.0.0  │ 24.5.2  │ @test/shared                   │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ @types/react (dev) │ 17.0.0  │ 17.0.0  │ 19.1.15 │ catalog:testing (@test/app)    │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ eslint (dev)       │ 7.0.0   │ 7.0.0   │ 9.36.0  │ catalog:testing (@test/app)    │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ typescript (dev)   │ 4.9.5   │ 4.9.5   │ 5.9.2   │ catalog:build (@test/app)      │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ jest (dev)         │ 26.0.0  │ 26.0.0  │ 30.2.0  │ catalog:testing (@test/shared) │
-├────────────────────┼─────────┼─────────┼─────────┼────────────────────────────────┤
-│ prettier (dev)     │ 2.0.0   │ 2.0.0   │ 3.6.2   │ catalog:build (@test/utils)    │
-└────────────────────┴─────────┴─────────┴─────────┴────────────────────────────────┘
-```
-
-{% bunCLIUsage command="outdated" /%}

package/docs/cli/patch-commit.md

@@ -1,11 +0,0 @@
-An alias for `bun patch --commit` to maintain compatibility with pnpm.
-
-To get started with patch, first prepare the package for patching with [`bun patch <pkg>`](https://bun.com/docs/install/patch).
-
-### `--patches-dir`
-
-By default, `bun patch-commit` will use the `patches` directory in the temporary directory.
-
-You can specify a different directory with the `--patches-dir` flag.
-
-{% bunCLIUsage command="patch-commit" /%}