puppeteer/docs/browsers-api/browsers.install.md

sidebar_label

sidebar_label
install

install() function

install(): Promise<InstalledBrowser>

Downloads and unpacks the browser archive according to the InstallOptions.

Signature

export declare function install(
  options: InstallOptions & {
    unpack?: true;
  },
): Promise<InstalledBrowser>;

Parameters

Parameter	Type	Description
options	InstallOptions & { unpack?: true; }

Returns:

Promise<InstalledBrowser>

a InstalledBrowser instance.

install(): Promise<string>

Downloads the browser archive according to the InstallOptions without unpacking.

Signature

export declare function install(
  options: InstallOptions & {
    unpack: false;
  },
): Promise<string>;

Parameters

Parameter	Type	Description
options	InstallOptions & { unpack: false; }

Returns:

Promise<string>

the absolute path to the archive.