Files
bun.sh/docs/guides/install/add-peer.mdx
Michael H 87eca6bbc7 docs: re-apply many recent changes that somehow aren't present (#24719)
lots of recent changes aren't present, so this reapplies them
2025-11-16 19:23:01 +11:00

46 lines
898 B
Plaintext

---
title: Add a peer dependency
sidebarTitle: Add a peer dependency
mode: center
---
To add an npm package as a peer dependency, use the `--peer` flag.
```sh terminal icon="terminal"
bun add @types/bun --peer
```
---
This will add the package to `peerDependencies` in `package.json`.
```json package.json icon="file-json"
{
"peerDependencies": {
"@types/bun": "^1.3.2" // [!code ++]
}
}
```
---
Running `bun install` will install peer dependencies by default, unless marked optional in `peerDependenciesMeta`.
{/* prettier-ignore */}
```json package.json icon="file-json"
{
"peerDependencies": {
"@types/bun": "^1.3.2"
},
"peerDependenciesMeta": {
"@types/bun": { // [!code ++]
"optional": true // [!code ++]
} // [!code ++]
}
}
```
---
See [Docs > Package manager](https://bun.com/docs/cli/install) for complete documentation of Bun's package manager.