github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify the path attribute of InstalledBrowser (#10588)

Browse Source
This commit is contained in:
Alex Rudenko 2023-07-19 12:32:22 +02:00 committed by GitHub
parent 830f926d48
commit 54c6ff2f3c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/browsers-api/browsers.installedbrowser.md
View File

@ -13,8 +13,8 @@ export interface InstalledBrowser
## Properties ## Properties
| Property | Modifiers | Type | Description | Default | | Property | Modifiers | Type | Description | Default |
| -------- | --------- | ------------------------------------------------ | ----------- | ------- | | -------- | --------- | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| browser | | [Browser](./browsers.browser.md) | | | | browser | | [Browser](./browsers.browser.md) | | |
| buildId | | string | | | | buildId | | string | | |
| path | | string | | | | path | | string | Path to the root of the installation folder. Use [computeExecutablePath()](./browsers.computeexecutablepath.md) to get the path to the executable binary. | |
| platform | | [BrowserPlatform](./browsers.browserplatform.md) | | | | platform | | [BrowserPlatform](./browsers.browserplatform.md) | | |

4
packages/browsers/src/Cache.ts
View File

@ -23,6 +23,10 @@ import {Browser, BrowserPlatform} from './browser-data/browser-data.js';
* @public * @public
*/ */
export interface InstalledBrowser { export interface InstalledBrowser {
/**
* Path to the root of the installation folder. Use
* {@link computeExecutablePath} to get the path to the executable binary.
*/
path: string; path: string;
browser: Browser; browser: Browser;
buildId: string; buildId: string;