bun-types 1.3.2-canary.20251105T140650 → 1.3.2-canary.20251106T140813

package/docs/guides/install/add.md

@@ -1,42 +0,0 @@
----
-name: Add a dependency
----
-
-To add an npm package as a dependency, use `bun add`.
-
-```sh
-$ bun add zod
-```
-
----
-
-This will add the package to `dependencies` in `package.json`. By default, the `^` range specifier will be used, to indicate that any future minor or patch versions are acceptable.
-
-```json-diff
-{
-  "dependencies": {
-+     "zod": "^3.0.0"
-  }
-}
-```
-
----
-
-To "pin" to an exact version of the package, use `--exact`. This will add the package to `dependencies` without the `^`, pinning your project to the exact version you installed.
-
-```sh
-$ bun add zod --exact
-```
-
----
-
-To specify an exact version or a tag:
-
-```sh
-$ bun add zod@3.0.0
-$ bun add zod@next
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.

package/docs/guides/install/azure-artifacts.md

@@ -1,73 +0,0 @@
----
-name: Using bun install with an Azure Artifacts npm registry
----
-
-{% callout %}
-In [Azure Artifact's](https://learn.microsoft.com/en-us/azure/devops/artifacts/npm/npmrc?view=azure-devops&tabs=windows%2Cclassic) instructions for `.npmrc`, they say to base64 encode the password. Do not do this for `bun install`. Bun will automatically base64 encode the password for you if needed.
-{% /callout %}
-
-[Azure Artifacts](https://azure.microsoft.com/en-us/products/devops/artifacts) is a package management system for Azure DevOps. It allows you to host your own private npm registry, npm packages, and other types of packages as well.
-
----
-
-### Configure with bunfig.toml
-
----
-
-To use it with `bun install`, add a `bunfig.toml` file to your project with the following contents. Make sure to replace `my-azure-artifacts-user` with your Azure Artifacts username, such as `jarred1234`.
-
-```toml#bunfig.toml
-[install.registry]
-url = "https://pkgs.dev.azure.com/my-azure-artifacts-user/_packaging/my-azure-artifacts-user/npm/registry"
-username = "my-azure-artifacts-user"
-# Bun v1.0.3+ supports using an environment variable here
-password = "$NPM_PASSWORD"
-```
-
----
-
-Then assign your Azure Personal Access Token to the `NPM_PASSWORD` environment variable. Bun [automatically reads](https://bun.com/docs/runtime/env) `.env` files, so create a file called `.env` in your project root. There is no need to base-64 encode this token! Bun will do this for you.
-
-```txt#.env
-NPM_PASSWORD=<paste token here>
-```
-
----
-
-### Configure with environment variables
-
----
-
-To configure Azure Artifacts without `bunfig.toml`, you can set the `NPM_CONFIG_REGISTRY` environment variable. The URL should include `:username` and `:_password` as query parameters. Replace `<USERNAME>` and `<PASSWORD>` with the apprropriate values.
-
-```bash#shell
-NPM_CONFIG_REGISTRY=https://pkgs.dev.azure.com/my-azure-artifacts-user/_packaging/my-azure-artifacts-user/npm/registry/:username=<USERNAME>:_password=<PASSWORD>
-```
-
----
-
-### Don't base64 encode the password
-
----
-
-In [Azure Artifact's](https://learn.microsoft.com/en-us/azure/devops/artifacts/npm/npmrc?view=azure-devops&tabs=windows%2Cclassic) instructions for `.npmrc`, they say to base64 encode the password. Do not do this for `bun install`. Bun will automatically base64 encode the password for you if needed.
-
-{% callout %}
-**Tip** — If it ends with `==`, it probably is base64 encoded.
-{% /callout %}
-
----
-
-To decode a base64-encoded password, open your browser console and run:
-
-```js
-atob("<base64-encoded password>");
-```
-
----
-
-Alternatively, use the `base64` command line tool, but doing so means it may be saved in your terminal history which is not recommended:
-
-```bash
-echo "base64-encoded-password" | base64 --decode
-```

package/docs/guides/install/cicd.md

@@ -1,41 +0,0 @@
----
-name: Install dependencies with Bun in GitHub Actions
----
-
-Use the official [`setup-bun`](https://github.com/oven-sh/setup-bun) GitHub Action to install `bun` in your GitHub Actions runner.
-
-```yaml-diff#workflow.yml
-name: my-workflow
-jobs:
-  my-job:
-    name: my-job
-    runs-on: ubuntu-latest
-    steps:
-      # ...
-      - uses: actions/checkout@v4
-+     - uses: oven-sh/setup-bun@v2
-
-      # run any `bun` or `bunx` command
-+     - run: bun install
-```
-
----
-
-To specify a version of Bun to install:
-
-```yaml-diff#workflow.yml
-name: my-workflow
-jobs:
-  my-job:
-    name: my-job
-    runs-on: ubuntu-latest
-    steps:
-      # ...
-      - uses: oven-sh/setup-bun@v2
-+       with:
-+         version: "latest" # or "canary"
-```
-
----
-
-Refer to the [README.md](https://github.com/oven-sh/setup-bun) for complete documentation of the `setup-bun` GitHub Action.

package/docs/guides/install/custom-registry.md

@@ -1,30 +0,0 @@
----
-name: Override the default npm registry for bun install
----
-
-The default registry is `registry.npmjs.org`. This can be globally configured in `bunfig.toml`.
-
-```toml#bunfig.toml
-[install]
-# set default registry as a string
-registry = "https://registry.npmjs.org"
-
-# if needed, set a token
-registry = { url = "https://registry.npmjs.org", token = "123456" }
-
-# if needed, set a username/password
-registry = "https://username:password@registry.npmjs.org"
-```
-
----
-
-Your `bunfig.toml` can reference environment variables. Bun automatically loads environment variables from `.env.local`, `.env.[NODE_ENV]`, and `.env`. See [Docs > Environment variables](https://bun.com/docs/runtime/env) for more information.
-
-```toml#bunfig.toml
-[install]
-registry = { url = "https://registry.npmjs.org", token = "$npm_token" }
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.

package/docs/guides/install/from-npm-install-to-bun-install.md

@@ -1,214 +0,0 @@
----
-name: Migrate from npm install to bun install
----
-
-`bun install` is a Node.js compatible npm client designed to be an incredibly fast successor to npm.
-
-We've put a lot of work into making sure that the migration path from `npm install` to `bun install` is as easy as running `bun install` instead of `npm install`.
-
-- **Designed for Node.js & Bun**: `bun install` installs a Node.js compatible `node_modules` folder. You can use it in place of `npm install` for Node.js projects without any code changes and without using Bun's runtime.
-- **Automatically converts `package-lock.json`** to bun's `bun.lock` lockfile format, preserving your existing resolved dependency versions without any manual work on your part. You can secretly use `bun install` in place of `npm install` at work without anyone noticing.
-- **`.npmrc` compatible**: bun install reads npm registry configuration from npm's `.npmrc`, so you can use the same configuration for both npm and Bun.
-- **Hardlinks**: On Windows and Linux, `bun install` uses hardlinks to conserve disk space and install times.
-
-```bash
-# It only takes one command to migrate
-$ bun i
-
-# To add dependencies:
-$ bun i @types/bun
-
-# To add devDependencies:
-$ bun i -d @types/bun
-
-# To remove a dependency:
-$ bun rm @types/bun
-```
-
----
-
-## Run package.json scripts faster
-
-Run scripts from package.json, executables from `node_modules/.bin` (sort of like `npx`), and JavaScript/TypeScript files (just like `node`) - all from a single simple command.
-
-| NPM                | Bun              |
-| ------------------ | ---------------- |
-| `npm run <script>` | `bun <script>`   |
-| `npm exec <bin>`   | `bun <bin>`      |
-| `node <file>`      | `bun <file>`     |
-| `npx <package>`    | `bunx <package>` |
-
-When you use `bun run <executable>`, it will choose the locally-installed executable
-
-```sh
-# Run a package.json script:
-$ bun my-script
-$ bun run my-script
-
-# Run an executable in node_modules/.bin:
-$ bun my-executable # such as tsc, esbuild, etc.
-$ bun run my-executable
-
-# Run a JavaScript/TypeScript file:
-$ bun ./index.ts
-```
-
----
-
-## Workspaces? Yes.
-
-`bun install` supports workspaces similarly to npm, with more features.
-
-In package.json, you can set `"workspaces"` to an array of relative paths.
-
-```json#package.json
-{
-  "name": "my-app",
-  "workspaces": ["packages/*", "apps/*"]
-}
-```
-
----
-
-### Filter scripts by workspace name
-
-In Bun, the `--filter` flag accepts a glob pattern, and will run the command concurrently for all workspace packages with a `name` that matches the pattern, respecting dependency order.
-
-```sh
-$ bun --filter 'lib-*' my-script
-# instead of:
-# npm run --workspace lib-foo --workspace lib-bar my-script
-```
-
----
-
-## Update dependencies
-
-To update a dependency, you can use `bun update <package>`. This will update the dependency to the latest version that satisfies the semver range specified in package.json.
-
-```sh
-# Update a single dependency
-$ bun update @types/bun
-
-# Update all dependencies
-$ bun update
-
-# Ignore semver, update to the latest version
-$ bun update @types/bun --latest
-
-# Update a dependency to a specific version
-$ bun update @types/bun@1.3.2-canary.20251105T140650
-
-# Update all dependencies to the latest versions
-$ bun update --latest
-```
-
----
-
-### View outdated dependencies
-
-To view outdated dependencies, run `bun outdated`. This is like `npm outdated` but with more compact output.
-
-```sh
-$ bun outdated
-┌────────────────────────────────────────┬─────────┬────────┬────────┐
-│ Package                                │ Current │ Update │ Latest │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ @types/bun (dev)                       │ 1.1.6   │ 1.1.10 │ 1.1.10 │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ @types/react (dev)                     │ 18.3.3  │ 18.3.8 │ 18.3.8 │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ @typescript-eslint/eslint-plugin (dev) │ 7.16.1  │ 7.18.0 │ 8.6.0  │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ @typescript-eslint/parser (dev)        │ 7.16.1  │ 7.18.0 │ 8.6.0  │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ @vscode/debugadapter (dev)             │ 1.66.0  │ 1.67.0 │ 1.67.0 │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ esbuild (dev)                          │ 0.21.5  │ 0.21.5 │ 0.24.0 │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ eslint (dev)                           │ 9.7.0   │ 9.11.0 │ 9.11.0 │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ mitata (dev)                           │ 0.1.11  │ 0.1.14 │ 1.0.2  │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ prettier-plugin-organize-imports (dev) │ 4.0.0   │ 4.1.0  │ 4.1.0  │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ source-map-js (dev)                    │ 1.2.0   │ 1.2.1  │ 1.2.1  │
-├────────────────────────────────────────┼─────────┼────────┼────────┤
-│ typescript (dev)                       │ 5.5.3   │ 5.6.2  │ 5.6.2  │
-└────────────────────────────────────────┴─────────┴────────┴────────┘
-```
-
----
-
-## List installed packages
-
-To list installed packages, you can use `bun pm ls`. This will list all the packages that are installed in the `node_modules` folder using Bun's lockfile as the source of truth. You can pass the `-a` flag to list all installed packages, including transitive dependencies.
-
-```sh
-# List top-level installed packages:
-$ bun pm ls
-my-pkg node_modules (781)
-├── @types/node@20.16.5
-├── @types/react@18.3.8
-├── @types/react-dom@18.3.0
-├── eslint@8.57.1
-├── eslint-config-next@14.2.8
-
-# List all installed packages:
-$ bun pm ls -a
-my-pkg node_modules
-├── @alloc/quick-lru@5.2.0
-├── @isaacs/cliui@8.0.2
-│   └── strip-ansi@7.1.0
-│       └── ansi-regex@6.1.0
-├── @jridgewell/gen-mapping@0.3.5
-├── @jridgewell/resolve-uri@3.1.2
-...
-```
-
----
-
-## Create a package tarball
-
-To create a package tarball, you can use `bun pm pack`. This will create a tarball of the package in the current directory.
-
-```sh
-# Create a tarball
-$ bun pm pack
-
-Total files: 46
-Shasum: 2ee19b6f0c6b001358449ca0eadead703f326216
-Integrity: sha512-ZV0lzWTEkGAMz[...]Gl4f8lA9sl97g==
-Unpacked size: 0.41MB
-Packed size: 117.50KB
-```
-
----
-
-## Shebang
-
-If the package references `node` in the `#!/usr/bin/env node` shebang, `bun run` will by default respect it and use the system's `node` executable. You can force it to use Bun's `node` by passing `--bun` to `bun run`.
-
-When you pass `--bun` to `bun run`, we create a symlink to the locally-installed Bun executable named `"node"` in a temporary directory and add that to your `PATH` for the duration of the script's execution.
-
-```sh
-# Force using Bun's runtime instead of node
-$ bun --bun my-script
-
-# This also works:
-$ bun run --bun my-script
-```
-
----
-
-## Global installs
-
-You can install packages globally using `bun i -g <package>`. This will install into a `.bun/install/global/node_modules` folder inside your home directory by default.
-
-```sh
-# Install a package globally
-$ bun i -g eslint
-
-# Run a globally-installed package without the `bun run` prefix
-$ eslint --init
-```

package/docs/guides/install/git-diff-bun-lockfile.md

@@ -1,44 +0,0 @@
----
-name: Configure git to diff Bun's lockb lockfile
----
-
-{% callout %}
-Bun v1.1.39 introduced `bun.lock`, a JSONC formatted lockfile. `bun.lock` is human-readable and git-diffable without configuration, at no cost to performance. [**Learn more.**](https://bun.com/docs/install/lockfile#text-based-lockfile)
-{% /callout %}
-
----
-
-To teach `git` how to generate a human-readable diff of Bun's binary lockfile format (`.lockb`), add the following to your local or global `.gitattributes` file:
-
-```js
-*.lockb binary diff=lockb
-```
-
----
-
-Then add the following to you local git config with:
-
-```sh
-$ git config diff.lockb.textconv bun
-$ git config diff.lockb.binary true
-```
-
----
-
-To globally configure git to diff Bun's lockfile, add the following to your global git config with:
-
-```sh
-$ git config --global diff.lockb.textconv bun
-$ git config --global diff.lockb.binary true
-```
-
----
-
-## How this works
-
-Why this works:
-
-- `textconv` tells git to run bun on the file before diffing
-- `binary` tells git to treat the file as binary (so it doesn't try to diff it line-by-line)
-
-In Bun, you can execute Bun's lockfile (`bun ./bun.lockb`) to generate a human-readable version of the lockfile and `git diff` can then use that to generate a human-readable diff.

package/docs/guides/install/jfrog-artifactory.md

@@ -1,28 +0,0 @@
----
-name: Using bun install with Artifactory
----
-
-[JFrog Artifactory](https://jfrog.com/artifactory/) is a package management system for npm, Docker, Maven, NuGet, Ruby, Helm, and more. It allows you to host your own private npm registry, npm packages, and other types of packages as well.
-
-To use it with `bun install`, add a `bunfig.toml` file to your project with the following contents:
-
----
-
-### Configure with bunfig.toml
-
-Make sure to replace `MY_SUBDOMAIN` with your JFrog Artifactory subdomain, such as `jarred1234` and MY_TOKEN with your JFrog Artifactory token.
-
-```toml#bunfig.toml
-[install.registry]
-url = "https://MY_SUBDOMAIN.jfrog.io/artifactory/api/npm/npm/_auth=MY_TOKEN"
-# Bun v1.0.3+ supports using an environment variable here
-# url = "$NPM_CONFIG_REGISTRY"
-```
-
----
-
-### Configure with `$NPM_CONFIG_REGISTRY`
-
-Like with npm, you can use the `NPM_CONFIG_REGISTRY` environment variable to configure JFrog Artifactory with bun install.
-
----

package/docs/guides/install/npm-alias.md

@@ -1,23 +0,0 @@
----
-name: Install a package under a different name
----
-
-To install an npm package under an alias:
-
-```sh
-$ bun add my-custom-name@npm:zod
-```
-
----
-
-The `zod` package can now be imported as `my-custom-name`.
-
-```ts
-import { z } from "my-custom-name";
-
-z.string();
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.

package/docs/guides/install/registry-scope.md

@@ -1,38 +0,0 @@
----
-name: Configure a private registry for an organization scope with bun install
----
-
-Private registries can be configured using either [`.npmrc`](https://bun.com/docs/install/npmrc) or [`bunfig.toml`](https://bun.com/docs/runtime/bunfig#install-registry). While both are supported, we recommend using **bunfig.toml** for enhanced flexibility and Bun-specific options.
-
-To configure a registry for a particular npm scope:
-
-```toml#bunfig.toml
-[install.scopes]
-# as a string
-"@myorg1" = "https://username:password@registry.myorg.com/"
-
-# as an object with username/password
-# you can reference environment variables
-"@myorg2" = {
-  username = "myusername",
-  password = "$npm_pass",
-  url = "https://registry.myorg.com/"
-}
-
-# as an object with token
-"@myorg3" = { token = "$npm_token", url = "https://registry.myorg.com/" }
-
-```
-
----
-
-Your `bunfig.toml` can reference environment variables. Bun automatically loads environment variables from `.env.local`, `.env.[NODE_ENV]`, and `.env`. See [Docs > Environment variables](https://bun.com/docs/runtime/env) for more information.
-
-```toml#bunfig.toml
-[install.scopes]
-"@myorg3" = { token = "$npm_token", url = "https://registry.myorg.com/" }
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.

package/docs/guides/install/trusted.md

@@ -1,46 +0,0 @@
----
-name: Add a trusted dependency
----
-
-Unlike other npm clients, Bun does not execute arbitrary lifecycle scripts for installed dependencies, such as `postinstall` and `node-gyp` builds. These scripts represent a potential security risk, as they can execute arbitrary code on your machine.
-
-{% callout %}
-Bun includes a default allowlist of popular packages containing `postinstall` scripts that are known to be safe. You can see this list [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt).
-{% /callout %}
-
----
-
-If you are seeing one of the following errors, you are probably trying to use a package that uses `postinstall` to work properly:
-
-- `error: could not determine executable to run for package`
-- `InvalidExe`
-
----
-
-To allow Bun to execute lifecycle scripts for a specific package, add the package to `trustedDependencies` in your package.json file. You can do this automatically by running the command `bun pm trust <pkg>`.
-
-{% callout %}
-Note that this only allows lifecycle scripts for the specific package listed in `trustedDependencies`, _not_ the dependencies of that dependency!
-{% /callout %}
-
-```json-diff
-  {
-    "name": "my-app",
-    "version": "1.0.0",
-+   "trustedDependencies": ["my-trusted-package"]
-  }
-```
-
----
-
-Once this is added, run a fresh install. Bun will re-install your dependencies and properly install
-
-```sh
-$ rm -rf node_modules
-$ rm bun.lock
-$ bun install
-```
-
----
-
-See [Docs > Package manager > Trusted dependencies](https://bun.com/docs/install/lifecycle) for complete documentation of trusted dependencies.

package/docs/guides/install/workspaces.md

@@ -1,70 +0,0 @@
----
-name: Configuring a monorepo using workspaces
----
-
-Bun's package manager supports npm `"workspaces"`. This allows you to split a codebase into multiple distinct "packages" that live in the same repository, can depend on each other, and (when possible) share a `node_modules` directory.
-
-Clone [this sample project](https://github.com/colinhacks/bun-workspaces) to experiment with workspaces.
-
----
-
-The root `package.json` should not contain any `"dependencies"`, `"devDependencies"`, etc. Each individual package should be self-contained and declare its own dependencies. Similarly, it's conventional to declare `"private": true` to avoid accidentally publishing the root package to `npm`.
-
-```json#package.json
-{
-  "name": "my-monorepo",
-  "private": true,
-  "workspaces": [
-    "packages/*"
-  ]
-}
-```
-
----
-
-It's common to place all packages in a `packages` directory. The `"workspaces"` field in package.json supports glob patterns, so you can use `packages/*` to indicate that each subdirectory of `packages` should be considered separate _package_ (also known as a workspace).
-
-```txt
-.
-├── package.json
-├── node_modules
-└── packages
-    ├── stuff-a
-    │   └── package.json
-    └── stuff-b
-        └── package.json
-```
-
----
-
-To add dependencies between workspaces, use the `"workspace:*"` syntax. Here we're adding `stuff-a` as a dependency of `stuff-b`.
-
-```json-diff#packages/stuff-b/package.json
-{
-  "name": "stuff-b",
-  "dependencies": {
-+   "stuff-a": "workspace:*"
-  }
-}
-```
-
----
-
-Once added, run `bun install` from the project root to install dependencies for all workspaces.
-
-```sh
-$ bun install
-```
-
----
-
-To add npm dependencies to a particular workspace, just `cd` to the appropriate directory and run `bun add` commands as you would normally. Bun will detect that you are in a workspace and hoist the dependency as needed.
-
-```sh
-$ cd packages/stuff-a
-$ bun add zod
-```
-
----
-
-See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.