Skip to content

Commit 9e0cf72

Browse files
aslushnikovpavelfeldman
authored andcommitted
docs(api.md): add missing docs (#664)
Follow-up to #641 that adds API entries.
1 parent 99414b0 commit 9e0cf72

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/api.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -374,12 +374,18 @@ Creates a new browser context. It won't share cookies/cache with other browser c
374374
### class: BrowserApp
375375

376376
<!-- GEN:toc -->
377+
- [event: 'close'](#event-close)
377378
- [browserApp.close()](#browserappclose)
378379
- [browserApp.connectOptions()](#browserappconnectoptions)
380+
- [browserApp.kill()](#browserappkill)
379381
- [browserApp.process()](#browserappprocess)
380382
- [browserApp.wsEndpoint()](#browserappwsendpoint)
381383
<!-- GEN:stop -->
382384

385+
#### event: 'close'
386+
387+
Emitted when the browser app closes.
388+
383389
#### browserApp.close()
384390
- returns: <[Promise]>
385391

@@ -393,6 +399,10 @@ Closes the browser gracefully and makes sure the process is terminated.
393399

394400
This options object can be passed to [browserType.connect(options)](#browsertypeconnectoptions) to establish connection to the browser.
395401

402+
#### browserApp.kill()
403+
404+
Kills the browser process.
405+
396406
#### browserApp.process()
397407
- returns: <?[ChildProcess]> Spawned browser application process.
398408

@@ -1785,7 +1795,7 @@ page.removeListener('request', logRequest);
17851795
```
17861796

17871797
<!-- GEN:toc -->
1788-
- [event: 'close'](#event-close)
1798+
- [event: 'close'](#event-close-1)
17891799
- [event: 'console'](#event-console)
17901800
- [event: 'dialog'](#event-dialog)
17911801
- [event: 'domcontentloaded'](#event-domcontentloaded)
@@ -3183,7 +3193,7 @@ Contains the URL of the response.
31833193
The [WebSocket] class represents websocket connections in the page.
31843194

31853195
<!-- GEN:toc -->
3186-
- [event: 'close'](#event-close-1)
3196+
- [event: 'close'](#event-close-2)
31873197
- [event: 'error'](#event-error)
31883198
- [event: 'messageReceived'](#event-messagereceived)
31893199
- [event: 'messageSent'](#event-messagesent)

0 commit comments

Comments
 (0)