From e6a4b7c05899ee6d6a821666b72023856081d5ca Mon Sep 17 00:00:00 2001
From: eleanor-park <eleanor_park@brown.edu>
Date: Fri, 13 Dec 2024 17:45:34 -0500
Subject: added comments, refactored duplicate code, and resolved lint errors

---
 .../imageEditorUtils/imageEditorInterfaces.ts          | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

(limited to 'src/client/views/nodes/imageEditor/imageEditorUtils/imageEditorInterfaces.ts')

diff --git a/src/client/views/nodes/imageEditor/imageEditorUtils/imageEditorInterfaces.ts b/src/client/views/nodes/imageEditor/imageEditorUtils/imageEditorInterfaces.ts
index 75659fc53..a14b55439 100644
--- a/src/client/views/nodes/imageEditor/imageEditorUtils/imageEditorInterfaces.ts
+++ b/src/client/views/nodes/imageEditor/imageEditorUtils/imageEditorInterfaces.ts
@@ -17,24 +17,26 @@ export enum ImageToolType {
     Cut = 'cut',
 }
 
+export enum CutMode {
+    IN,
+    OUT,
+    DRAW_IN,
+    ERASE,
+}
+
 export interface ImageEditTool {
     type: ImageToolType;
     name: string;
     btnText: string;
     icon: IconProp;
-    applyFunc: (currCutType: BrushMode, brushWidth: number, prevEdits: { url: string; saveRes: Doc | undefined }[], isFirstDoc: boolean) => Promise<void>;
+    // this is the function that the image tool applies, so it can be defined depending on the tool
+    applyFunc: (currCutType: CutMode, brushWidth: number, prevEdits: { url: string; saveRes: Doc | undefined }[], isFirstDoc: boolean) => Promise<void>;
+    // these optional parameters are here because different tools require different brush sizes and defaults
     sliderMin?: number;
     sliderMax?: number;
     sliderDefault?: number;
 }
 
-export enum BrushMode {
-    IN,
-    OUT,
-    LINE_IN,
-    LINE_OUT,
-}
-
 export interface ImageDimensions {
     width: number;
     height: number;
-- 
cgit v1.2.3-70-g09d2