VTEX Developer Portal

Peer dependencies is how we call a JSON object field (peerDependencies) in the app's manifest.json file.

This field is used to specify the set of IO apps an app relies on to properly work. However, unlike regular dependencies, peer dependencies are not automatically installed in an account. Hence, setting peer dependencies can be especially useful for cases when an app relies on a paid app, for example.

Another use case for the peerDependencies field is when your app relies on an app that has different major versions, which can affect other app's functionalities depending on the installed version. Therefore, instead of automatically installing such dependency, you need to guarantee that the account installing your new app already has installed your app's dependencies in the same major version specified in the peerDependencies field.

To make it more tangible, take the following example, in which [email protected] and vtex.paid-app-e[email protected] are declared as peer dependencies of the vtex.example app.

{
  "name": "vtex.example",  
  ...
  "peerDependencies": {
      "vtex.store": "2.x",
      "vtex.paid-app-example": "1.x"
  },
  "dependencies": {
      "vtex.styleguide": "9.x"
  }
  ...
}

For this example, if you wanted to install the vtex.example app in an account, you'd first need to manually install the exact versions of vtex.store and vtex.paid-app-example apps declared under the peerDependencies field.

Now, considering the development context, suppose the following: you are developing an app called X that directly depends on the vtex.example app. Therefore, you listvtex.example as a dependency in the dependencies field from the X's manifest.json file.

The vtex.example app, in turn, has [email protected] and [email protected] set as its peerDependencies. In practice, this means that in order to develop your app X (whose dependencies field includes vtex.example), you will have to manually install [email protected] and [email protected] in the VTEX account in which you are working.

If your account does not have [email protected] and [email protected] installed, you won't be able to install the vtex.example and your development flow will be interrupted.

Notice that, this way, the vtex.example forces every account that is installing it to also have [email protected] and [email protected] installed.

️ Keep in mind: Peer dependencies are not automatically installed, therefore you will have to manually install them in the account in which you are working. As a result, if your app relies on a paid app you should declare it as a peer dependency.

Updated 13 days ago


Peer Dependencies


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.