Parcourir la source

docs: update plugin api component for failSilently (#5953)

bubble
Tim Lai il y a 4 ans
committed by GitHub
Parent
révision
ba953aaa91
Aucune clé connue n'a été trouvée dans la base pour cette signature ID de la clé GPG: 4AEE18F83AFDEB23
1 fichiers modifiés avec 7 ajouts et 0 suppressions
  1. +7
    -0
      docs/customization/plugin-api.md

+ 7
- 0
docs/customization/plugin-api.md Voir le fichier

@@ -214,6 +214,13 @@ const NeverShowInfoPlugin = function(system) {
}
```

You can use `config.failSilently` if you don't want a warning when a component doesn't exist in the system.

Be mindful of `getComponent` arguments order. In the example below, the boolean `false` refers to presence of a container, and the 3rd argument is the config object used to suppress the missing component warning.
```javascript
const thisVariableWillBeNull = getComponent("not_real", false, { failSilently: true })
```

#### Wrap-Actions

Wrap Actions allow you to override the behavior of an action in the system.


Chargement…
Annuler
Enregistrer