From 9e0cf726ce2b6dab49ed929a6b6904da86b3cd5d Mon Sep 17 00:00:00 2001 From: Andrey Lushnikov Date: Mon, 27 Jan 2020 08:27:45 -0800 Subject: [PATCH] docs(api.md): add missing docs (#664) Follow-up to #641 that adds API entries. --- docs/api.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index fee23ed622..05549eeb44 100644 --- a/docs/api.md +++ b/docs/api.md @@ -374,12 +374,18 @@ Creates a new browser context. It won't share cookies/cache with other browser c ### class: BrowserApp +- [event: 'close'](#event-close) - [browserApp.close()](#browserappclose) - [browserApp.connectOptions()](#browserappconnectoptions) +- [browserApp.kill()](#browserappkill) - [browserApp.process()](#browserappprocess) - [browserApp.wsEndpoint()](#browserappwsendpoint) +#### event: 'close' + +Emitted when the browser app closes. + #### browserApp.close() - returns: <[Promise]> @@ -393,6 +399,10 @@ Closes the browser gracefully and makes sure the process is terminated. This options object can be passed to [browserType.connect(options)](#browsertypeconnectoptions) to establish connection to the browser. +#### browserApp.kill() + +Kills the browser process. + #### browserApp.process() - returns: Spawned browser application process. @@ -1785,7 +1795,7 @@ page.removeListener('request', logRequest); ``` -- [event: 'close'](#event-close) +- [event: 'close'](#event-close-1) - [event: 'console'](#event-console) - [event: 'dialog'](#event-dialog) - [event: 'domcontentloaded'](#event-domcontentloaded) @@ -3183,7 +3193,7 @@ Contains the URL of the response. The [WebSocket] class represents websocket connections in the page. -- [event: 'close'](#event-close-1) +- [event: 'close'](#event-close-2) - [event: 'error'](#event-error) - [event: 'messageReceived'](#event-messagereceived) - [event: 'messageSent'](#event-messagesent)