From c4391567f3a69320cbf8f2e41c4ed9fd68878909 Mon Sep 17 00:00:00 2001
From: Daniel Lockyer <hi@daniellockyer.com>
Date: Fri, 13 Jan 2023 16:08:55 +0100
Subject: [PATCH] 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`
---
 ghost/mailgun-client/lib/mailgun-client.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/ghost/mailgun-client/lib/mailgun-client.js b/ghost/mailgun-client/lib/mailgun-client.js
index acc977c402..f56d0343ac 100644
--- a/ghost/mailgun-client/lib/mailgun-client.js
+++ b/ghost/mailgun-client/lib/mailgun-client.js
@@ -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();