Skip to content

docs: add example to optionalDependencies section #9363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
owlstronaut merged 1 commit into from
May 15, 2026
+10 −0
Merged

docs: add example to optionalDependencies section #9363

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/lib/content/configuring-npm/package-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,6 +842,16 @@ This is a map of package name to version or URL, just like the `dependencies` ob
The difference is that build failures do not cause installation to fail.
Running `npm install --omit=optional` will prevent these dependencies from being installed.

For example:

```json
{
"optionalDependencies": {
"@npm/foo": "^1.0.0"
}
}
```

It is still your program's responsibility to handle the lack of the dependency.
For example, something like this:

Expand Down
Loading