docs: better cache docs

sitespeedio · Jan 3, 2024 · 0562bd7 · 0562bd7
1 parent 39c99dc
commit 0562bd7
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 11 deletions.
diff --git a/lib/core/engine/command/cache.js b/lib/core/engine/command/cache.js
@@ -2,14 +2,34 @@ import intel from 'intel';
 const log = intel.getLogger('browsertime.command.cache');
 export class Cache {
   constructor(browser, browserName, extensionServer, cdp) {
+    /**
+     * @private
+     */
     this.browser = browser;
+    /**
+     * @private
+     */
     this.browserName = browserName;
+    /**
+     * @private
+     */
     this.extensionServer = extensionServer;
+    /**
+     * @private
+     */
     this.cdp = cdp;
   }
 
   /**
-   * Clear the browser cache. Will clear browser cache and cookies.
+   * Clears the browser cache. This includes both cache and cookies.
+   *
+   * For Firefox, it uses the extensionServer setup with specific options.
+   * For Chrome and Edge, it uses the Chrome DevTools Protocol (CDP) commands.
+   * If the browser is not supported, logs an error message.
+   *
+   * @async
+   * @throws Will throw an error if the browser is not supported.
+   * @returns {Promise<void>} A promise that resolves when the cache and cookies are cleared.
    */
   async clear() {
     if (this.browserName === 'firefox') {
@@ -28,7 +48,15 @@ export class Cache {
   }
 
   /**
-   * Clear the browser cache but keep cookies.
+   * Clears the browser cache while keeping the cookies.
+   *
+   * For Firefox, it uses the extensionServer setup with specific options.
+   * For Chrome and Edge, it uses the Chrome DevTools Protocol (CDP) command to clear the cache.
+   * If the browser is not supported, logs an error message.
+   *
+   * @async
+   * @throws Will throw an error if the browser is not supported.
+   * @returns {Promise<void>} A promise that resolves when the cache is cleared but cookies are kept.
    */
   async clearKeepCookies() {
     if (this.browserName === 'firefox') {

diff --git a/types/core/engine/command/cache.d.ts b/types/core/engine/command/cache.d.ts
@@ -1,16 +1,44 @@
 export class Cache {
     constructor(browser: any, browserName: any, extensionServer: any, cdp: any);
-    browser: any;
-    browserName: any;
-    extensionServer: any;
-    cdp: any;
     /**
-     * Clear the browser cache. Will clear browser cache and cookies.
+     * @private
      */
-    clear(): Promise<any>;
+    private browser;
     /**
-     * Clear the browser cache but keep cookies.
+     * @private
      */
-    clearKeepCookies(): Promise<any>;
+    private browserName;
+    /**
+     * @private
+     */
+    private extensionServer;
+    /**
+     * @private
+     */
+    private cdp;
+    /**
+     * Clears the browser cache. This includes both cache and cookies.
+     *
+     * For Firefox, it uses the extensionServer setup with specific options.
+     * For Chrome and Edge, it uses the Chrome DevTools Protocol (CDP) commands.
+     * If the browser is not supported, logs an error message.
+     *
+     * @async
+     * @throws Will throw an error if the browser is not supported.
+     * @returns {Promise<void>} A promise that resolves when the cache and cookies are cleared.
+     */
+    clear(): Promise<void>;
+    /**
+     * Clears the browser cache while keeping the cookies.
+     *
+     * For Firefox, it uses the extensionServer setup with specific options.
+     * For Chrome and Edge, it uses the Chrome DevTools Protocol (CDP) command to clear the cache.
+     * If the browser is not supported, logs an error message.
+     *
+     * @async
+     * @throws Will throw an error if the browser is not supported.
+     * @returns {Promise<void>} A promise that resolves when the cache is cleared but cookies are kept.
+     */
+    clearKeepCookies(): Promise<void>;
 }
 //# sourceMappingURL=cache.d.ts.map
diff --git a/types/core/engine/command/cache.d.ts.map b/types/core/engine/command/cache.d.ts.map