aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/install/add-optional.md
blob: 6d02c23e20708a07f61be8619b8b2ceb523bb576 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
---
name: Add an optional dependency
---

To add an npm package as a peer dependency, use the `--optional` flag.

```sh
$ bun add zod --optional
```

---

This will add the package to `optionalDependencies` in `package.json`.

```json-diff
{
  "optionalDependencies": {
+   "zod": "^3.0.0"
  }
}
```

---

See [Docs > Package manager](/docs/cli/install) for complete documentation of Bun's package manager.
2023-08-06fix nanbun-v0.7.3Gravatar Jarred Sumner 1-0/+3 2023-08-06Update coverage.mdGravatar Jarred Sumner 1-1/+1 2023-08-06Update lol-htmlGravatar Jarred Sumner 1-0/+0 2023-08-06Fixes #3129 (#4018)Gravatar Jarred Sumner 3-104/+58 2023-08-06Code coverage for `bun test` (#3975)Gravatar Jarred Sumner 32-61/+1211 2023-08-06feat: impl `dns.getServers` (#3982)Gravatar Ai Hoshino 5-3/+135 2023-08-06Implement --test-name-pattern (#3998)Gravatar dave caruso 8-7/+151 2023-08-05Fix(cli/init): support subpath entrypoint. (#4002)Gravatar Ai Hoshino 1-1/+8 2023-08-05Remove Bun.plugin transpiler hook, encourage usage of `--preload` instead (#3...Gravatar dave caruso 5-243/+1 2023-08-04Support --dev/-D and support more flags on bun install (#3989)Gravatar Colin McDonnell 5-9/+14 2023-08-04fix macro string escaping (#3967)Gravatar Dylan Conway 4-8/+97 2023-08-04Fixes #3991Gravatar Jarred Sumner 2-4/+40 2023-08-04[install] handle `workspace:*` correctly (#3994)Gravatar Alex Lam S.L 2-54/+158 2023-08-04Update import-meta.mdGravatar Jarred Sumner 1-2/+1 2023-08-04Fix incorrect docsGravatar Jarred Sumner 1-2/+3 2023-08-04[types] fix `blob.json()` (#3995)Gravatar Alex Lam S.L 1-4/+4 2023-08-04FFI typo (#3973)Gravatar dave caruso 3-5/+10 2023-08-04Buffer.copy should ignore out-of-range sourceEnd (#3971)Gravatar Yifei Wang 2-17/+34 2023-08-04[install] store resolved workspace path in lockfile (#3974)Gravatar Alex Lam S.L 5-82/+187 2023-08-04Fix types (#3963)Gravatar Colin McDonnell 14-274/+892 2023-08-04feat(hot-clear-screen): clear terminal on hot reload (#3976)Gravatar simylein 1-0/+7