feat(settings): add beforeSave check (#161)

1 files changed, 7 insertions, 0 deletions

diff --git a/src/utils/types.ts b/src/utils/types.ts
index 1916f9b..41dd0c1 100644
--- a/src/utils/types.ts
+++ b/src/utils/types.ts
@@ -16,6 +16,8 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
+import { Promisable } from "type-fest";
+
 import { Command } from "../api/Commands";
 
 // exists to export default definePlugin({...})
@@ -76,6 +78,11 @@ interface PluginDef {
      */
     options?: Record<string, PluginOptionsItem>;
     /**
+     * Check that this returns true before allowing a save to complete.
+     * If a string is returned, show the error to the user.
+     */
+    beforeSave?(options: Record<string, any>): Promisable<true | string>;
+    /**
      * Allows you to specify a custom Component that will be rendered in your
      * plugin's settings page
      */