Updated jsdoc for mailgun-client

- in the event the Mailgun config doesn't exist, we return `null` from
  this function
- this updates the jsdoc to correct the return type of `getInstance`
This commit is contained in:
Daniel Lockyer 2023-01-13 16:08:55 +01:00
parent 7d060e5edb
commit c4391567f3
No known key found for this signature in database

View File

@ -254,7 +254,7 @@ module.exports = class MailgunClient {
* Note: if the credentials are not configure, this method returns `null` and it is down to the
* consumer to act upon this/log this out
*
* @returns {import('mailgun.js')} the Mailgun client instance
* @returns {import('mailgun.js')|null} the Mailgun client instance
*/
getInstance() {
const mailgunConfig = this.#getConfig();