refactor: more documents on interfaces

wdhongtw · Jan 16, 2025 · 0dc00bb · 0dc00bb
1 parent 493f045
commit 0dc00bb
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/manager.ts b/src/manager.ts
@@ -303,9 +303,16 @@ export default class KeyStatusManager {
     }
 }
 
+/** The abstract storage for our application, focusing on string type. */
 export interface Storage {
+
+    /** Get the value for the key. */
     get(key: string): Promise<string | undefined>
+
+    /** Update or insert value for the key. */
     set(key: string, value: string): Promise<void>
+
+    /** Delete a value for some key, if any. */
     delete(key: string): Promise<void>
 }