chore: PoolDictionary comments

2024-06-01 08:57:10 +05:30
parent 8ae020b93b
commit a7aca9c1a4
1 changed files with 6 additions and 1 deletions
--- a/server/src/browser-management/classes/BrowserPool.ts
+++ b/server/src/browser-management/classes/BrowserPool.ts
@@ -17,7 +17,12 @@ interface BrowserPoolInfo {
    active: boolean,
 }

-
+/**
+ * Dictionary of all the active remote browser's instances indexed by their id.
+ * The value in this dictionary is of type BrowserPoolInfo,
+ * which provides additional information about the browser's usage.
+ * @category Types
+ */
 interface PoolDictionary {
    [key: string]: BrowserPoolInfo,
 }