有時候我們可以從 package.json 檔案裡發現下面這些定義：

```json
{
  //...
  "peerDependencies": {
    "libraryName": "1.x"
  }
}
```

`dependencies` 是我們的專案所依賴的包。

`devDependencies` 是在開發階段需要的包。 比如說像 Jest 這樣的測試框架或像 Babel 或 ESLint 這樣的其他實用程式。

在這兩種情況下，當我們安裝一個包時，npm 會自動安裝它的 `dependencies` 和 devDependencies.

peerDependencies 的工作機制不同。 它們`不會`自動安裝。

當一個依賴項(`dependency`)在包中列為 peerDependency 時，它不會自動被安裝。 相反，包含了這個包的應用程式碼，必須包含它作為其依賴項。

看一個例子。

專案 a 的 package.json，包含了專案 b：

```json
{
  //...
  "dependencies": {
    "b": "1.x"
  }
}
```
專案 b 的 package.json：

```json
{
  //...
  "peerDependencies": {
    "c": "1.x"
  }
}
```
因此，在包 A 中，我們必須新增 c 作為依賴項，否則當您安裝包 b 時，npm 會丟擲一個警告（並且程式碼可能會在執行時失敗）：

a 的 package.json：

```json
{
  //...
  "dependencies": {
    "b": "1.x",
    "c": "1.x"
  }
}
```

[peerDependencies](https://nodejs.org/uk/blog/npm/peer-dependencies/)的一個問題：

如果我的包依賴於 request 版本 2 和其他庫，但其他庫依賴於 request 版本 1，則生成的依賴關係圖如下所示：

![](https://img-blog.csdnimg.cn/img_convert/64c854ad5cd6dcb4843033e9224cc2fb.png)

現在 some-other-library 擁有自己的請求 v1 副本，同時不會干擾應用程式本身 request 包的 v2 副本。

總之，對等依賴項幾乎與普通依賴項一樣，但不是在 A 和 B 之間定義強需求（即您正在開發的專案及其所依賴的專案），它們旨在指定您的程式碼所需的包，但不併不是直接 require 它。

想象一下，我們正在開發模組 A，它是模組 B 的外掛。這意味著 A 將與 B 一起使用，為此，A 需要遵循一定的結構，並且很可能有一個符合以下標準的公共 API，以被 B 的方法中呼叫。

```typescript
//in your code...
B.addPlugin(new A())
//....

B.method() //internally using A's code here.
```

Node.js 應用 peer dependency 的用法

相關文章