docs: move ProductLauncher to abstract class (#11324)

puppeteer · Nov 8, 2023 · f7cf05c · f7cf05c
1 parent 1927fb5
commit f7cf05c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 20 deletions.
diff --git a/docs/api/puppeteer.productlauncher.defaultargs.md b/docs/api/puppeteer.productlauncher.defaultargs.md
@@ -8,7 +8,7 @@ sidebar_label: ProductLauncher.defaultArgs
 
 ```typescript
 class ProductLauncher {
-  defaultArgs(object: BrowserLaunchArgumentOptions): string[];
+  abstract defaultArgs(object: BrowserLaunchArgumentOptions): string[];
 }
 ```
 

diff --git a/docs/api/puppeteer.productlauncher.executablepath.md b/docs/api/puppeteer.productlauncher.executablepath.md
@@ -8,7 +8,7 @@ sidebar_label: ProductLauncher.executablePath
 
 ```typescript
 class ProductLauncher {
-  executablePath(channel?: ChromeReleaseChannel): string;
+  abstract executablePath(channel?: ChromeReleaseChannel): string;
 }
 ```
 

diff --git a/docs/api/puppeteer.productlauncher.md b/docs/api/puppeteer.productlauncher.md
@@ -9,7 +9,7 @@ Describes a launcher - a class that is able to create and launch a browser insta
 #### Signature:
 
 ```typescript
-export declare class ProductLauncher
+export declare abstract class ProductLauncher
 ```
 
 ## Remarks

diff --git a/packages/puppeteer-core/src/node/ProductLauncher.ts b/packages/puppeteer-core/src/node/ProductLauncher.ts
@@ -58,7 +58,7 @@ export interface ResolvedLaunchArgs {
  *
  * @public
  */
-export class ProductLauncher {
+export abstract class ProductLauncher {
   #product: Product;
 
   /**
@@ -201,15 +201,9 @@ export class ProductLauncher {
     return browser;
   }
 
-  executablePath(channel?: ChromeReleaseChannel): string;
-  executablePath(): string {
-    throw new Error('Not implemented');
-  }
+  abstract executablePath(channel?: ChromeReleaseChannel): string;
 
-  defaultArgs(object: BrowserLaunchArgumentOptions): string[];
-  defaultArgs(): string[] {
-    throw new Error('Not implemented');
-  }
+  abstract defaultArgs(object: BrowserLaunchArgumentOptions): string[];
 
   /**
    * Set only for Firefox, after the launcher resolves the `latest` revision to
@@ -223,23 +217,17 @@ export class ProductLauncher {
   /**
    * @internal
    */
-  protected async computeLaunchArguments(
+  protected abstract computeLaunchArguments(
     options: PuppeteerNodeLaunchOptions
   ): Promise<ResolvedLaunchArgs>;
-  protected async computeLaunchArguments(): Promise<ResolvedLaunchArgs> {
-    throw new Error('Not implemented');
-  }
 
   /**
    * @internal
    */
-  protected async cleanUserDataDir(
+  protected abstract cleanUserDataDir(
     path: string,
     opts: {isTemp: boolean}
   ): Promise<void>;
-  protected async cleanUserDataDir(): Promise<void> {
-    throw new Error('Not implemented');
-  }
 
   /**
    * @internal