Improved adapter manager JSDoc

refs https://github.com/TryGhost/Toolbox/issues/384

- The config is an optional parameter as not all class constructors necessarily have have to have configuration values
This commit is contained in:
Naz 2022-09-06 09:54:42 +08:00
parent a0d0c38aaf
commit 2f2033e7c5
No known key found for this signature in database

View File

@ -58,7 +58,7 @@ module.exports = class AdapterManager {
*
* @param {string} adapterType The type of adapter, e.g. "storage" or "scheduling"
* @param {string} adapterName The active adapter, e.g. "LocalFileStorage"
* @param {object} config The config the adapter should be instantiated with
* @param {object} [config] The config the adapter could be instantiated with
*
* @returns {Adapter} The resolved and instantiated adapter
*/