doc: fix doc linter (#2)

This commit is contained in:
Pavel Feldman 2019-11-19 13:59:52 -08:00 committed by GitHub
parent 6b5ab68e70
commit 60f332d01b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 323 additions and 327 deletions

View file

@ -9,326 +9,324 @@
##### Table of Contents ##### Table of Contents
<!-- GEN:toc --> <!-- GEN:toc -->
- [Playwright API Tip-Of-Tree](#playwright-api-tip-of-tree) - [Overview](#overview)
- [Table of Contents](#table-of-contents) - [playwright vs playwright-core](#playwright-vs-playwright-core)
- [Overview](#overview) - [Environment Variables](#environment-variables)
- [playwright vs playwright-core](#playwright-vs-playwright-core) - [Working with Chrome Extensions](#working-with-chrome-extensions)
- [Environment Variables](#environment-variables) - [class: Playwright](#class-playwright)
- [Working with Chrome Extensions](#working-with-chrome-extensions) * [playwright.connect(options)](#playwrightconnectoptions)
- [class: Playwright](#class-playwright) * [playwright.createBrowserFetcher([options])](#playwrightcreatebrowserfetcheroptions)
- [playwright.connect(options)](#playwrightconnectoptions) * [playwright.defaultArgs([options])](#playwrightdefaultargsoptions)
- [playwright.createBrowserFetcher([options])](#playwrightcreatebrowserfetcheroptions) * [playwright.devices](#playwrightdevices)
- [playwright.defaultArgs([options])](#playwrightdefaultargsoptions) * [playwright.errors](#playwrighterrors)
- [playwright.devices](#playwrightdevices) * [playwright.executablePath()](#playwrightexecutablepath)
- [playwright.errors](#playwrighterrors) * [playwright.launch([options])](#playwrightlaunchoptions)
- [playwright.executablePath()](#playwrightexecutablepath) - [class: BrowserFetcher](#class-browserfetcher)
- [playwright.launch([options])](#playwrightlaunchoptions) * [browserFetcher.canDownload(revision)](#browserfetchercandownloadrevision)
- [class: BrowserFetcher](#class-browserfetcher) * [browserFetcher.download(revision[, progressCallback])](#browserfetcherdownloadrevision-progresscallback)
- [browserFetcher.canDownload(revision)](#browserfetchercandownloadrevision) * [browserFetcher.localRevisions()](#browserfetcherlocalrevisions)
- [browserFetcher.download(revision[, progressCallback])](#browserfetcherdownloadrevision-progresscallback) * [browserFetcher.platform()](#browserfetcherplatform)
- [browserFetcher.localRevisions()](#browserfetcherlocalrevisions) * [browserFetcher.remove(revision)](#browserfetcherremoverevision)
- [browserFetcher.platform()](#browserfetcherplatform) * [browserFetcher.revisionInfo(revision)](#browserfetcherrevisioninforevision)
- [browserFetcher.remove(revision)](#browserfetcherremoverevision) - [class: Browser](#class-browser)
- [browserFetcher.revisionInfo(revision)](#browserfetcherrevisioninforevision) * [event: 'disconnected'](#event-disconnected)
- [class: Browser](#class-browser) * [event: 'targetchanged'](#event-targetchanged)
- [event: 'disconnected'](#event-disconnected) * [event: 'targetcreated'](#event-targetcreated)
- [event: 'targetchanged'](#event-targetchanged) * [event: 'targetdestroyed'](#event-targetdestroyed)
- [event: 'targetcreated'](#event-targetcreated) * [browser.browserContexts()](#browserbrowsercontexts)
- [event: 'targetdestroyed'](#event-targetdestroyed) * [browser.close()](#browserclose)
- [browser.browserContexts()](#browserbrowsercontexts) * [browser.createIncognitoBrowserContext()](#browsercreateincognitobrowsercontext)
- [browser.close()](#browserclose) * [browser.defaultBrowserContext()](#browserdefaultbrowsercontext)
- [browser.createIncognitoBrowserContext()](#browsercreateincognitobrowsercontext) * [browser.disconnect()](#browserdisconnect)
- [browser.defaultBrowserContext()](#browserdefaultbrowsercontext) * [browser.isConnected()](#browserisconnected)
- [browser.disconnect()](#browserdisconnect) * [browser.newPage()](#browsernewpage)
- [browser.isConnected()](#browserisconnected) * [browser.pages()](#browserpages)
- [browser.newPage()](#browsernewpage) * [browser.process()](#browserprocess)
- [browser.pages()](#browserpages) * [browser.target()](#browsertarget)
- [browser.process()](#browserprocess) * [browser.targets()](#browsertargets)
- [browser.target()](#browsertarget) * [browser.userAgent()](#browseruseragent)
- [browser.targets()](#browsertargets) * [browser.version()](#browserversion)
- [browser.userAgent()](#browseruseragent) * [browser.waitForTarget(predicate[, options])](#browserwaitfortargetpredicate-options)
- [browser.version()](#browserversion) * [browser.wsEndpoint()](#browserwsendpoint)
- [browser.waitForTarget(predicate[, options])](#browserwaitfortargetpredicate-options) - [class: BrowserContext](#class-browsercontext)
- [browser.wsEndpoint()](#browserwsendpoint) * [event: 'targetchanged'](#event-targetchanged-1)
- [class: BrowserContext](#class-browsercontext) * [event: 'targetcreated'](#event-targetcreated-1)
- [event: 'targetchanged'](#event-targetchanged-1) * [event: 'targetdestroyed'](#event-targetdestroyed-1)
- [event: 'targetcreated'](#event-targetcreated-1) * [browserContext.browser()](#browsercontextbrowser)
- [event: 'targetdestroyed'](#event-targetdestroyed-1) * [browserContext.clearPermissionOverrides()](#browsercontextclearpermissionoverrides)
- [browserContext.browser()](#browsercontextbrowser) * [browserContext.close()](#browsercontextclose)
- [browserContext.clearPermissionOverrides()](#browsercontextclearpermissionoverrides) * [browserContext.isIncognito()](#browsercontextisincognito)
- [browserContext.close()](#browsercontextclose) * [browserContext.newPage()](#browsercontextnewpage)
- [browserContext.isIncognito()](#browsercontextisincognito) * [browserContext.overridePermissions(origin, permissions)](#browsercontextoverridepermissionsorigin-permissions)
- [browserContext.newPage()](#browsercontextnewpage) * [browserContext.pages()](#browsercontextpages)
- [browserContext.overridePermissions(origin, permissions)](#browsercontextoverridepermissionsorigin-permissions) * [browserContext.targets()](#browsercontexttargets)
- [browserContext.pages()](#browsercontextpages) * [browserContext.waitForTarget(predicate[, options])](#browsercontextwaitfortargetpredicate-options)
- [browserContext.targets()](#browsercontexttargets) - [class: Page](#class-page)
- [browserContext.waitForTarget(predicate[, options])](#browsercontextwaitfortargetpredicate-options) * [event: 'close'](#event-close)
- [class: Page](#class-page) * [event: 'console'](#event-console)
- [event: 'close'](#event-close) * [event: 'dialog'](#event-dialog)
- [event: 'console'](#event-console) * [event: 'domcontentloaded'](#event-domcontentloaded)
- [event: 'dialog'](#event-dialog) * [event: 'error'](#event-error)
- [event: 'domcontentloaded'](#event-domcontentloaded) * [event: 'frameattached'](#event-frameattached)
- [event: 'error'](#event-error) * [event: 'framedetached'](#event-framedetached)
- [event: 'frameattached'](#event-frameattached) * [event: 'framenavigated'](#event-framenavigated)
- [event: 'framedetached'](#event-framedetached) * [event: 'load'](#event-load)
- [event: 'framenavigated'](#event-framenavigated) * [event: 'metrics'](#event-metrics)
- [event: 'load'](#event-load) * [event: 'pageerror'](#event-pageerror)
- [event: 'metrics'](#event-metrics) * [event: 'popup'](#event-popup)
- [event: 'pageerror'](#event-pageerror) * [event: 'request'](#event-request)
- [event: 'popup'](#event-popup) * [event: 'requestfailed'](#event-requestfailed)
- [event: 'request'](#event-request) * [event: 'requestfinished'](#event-requestfinished)
- [event: 'requestfailed'](#event-requestfailed) * [event: 'response'](#event-response)
- [event: 'requestfinished'](#event-requestfinished) * [event: 'workercreated'](#event-workercreated)
- [event: 'response'](#event-response) * [event: 'workerdestroyed'](#event-workerdestroyed)
- [event: 'workercreated'](#event-workercreated) * [page.$(selector)](#pageselector)
- [event: 'workerdestroyed'](#event-workerdestroyed) * [page.$$(selector)](#pageselector-1)
- [page.$(selector)](#pageselector) * [page.$$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args)
- [page.$$(selector)](#pageselector) * [page.$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args-1)
- [page.$$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args) * [page.$x(expression)](#pagexexpression)
- [page.$eval(selector, pageFunction[, ...args])](#pageevalselector-pagefunction-args) * [page.accessibility](#pageaccessibility)
- [page.$x(expression)](#pagexexpression) * [page.addScriptTag(options)](#pageaddscripttagoptions)
- [page.accessibility](#pageaccessibility) * [page.addStyleTag(options)](#pageaddstyletagoptions)
- [page.addScriptTag(options)](#pageaddscripttagoptions) * [page.authenticate(credentials)](#pageauthenticatecredentials)
- [page.addStyleTag(options)](#pageaddstyletagoptions) * [page.bringToFront()](#pagebringtofront)
- [page.authenticate(credentials)](#pageauthenticatecredentials) * [page.browser()](#pagebrowser)
- [page.bringToFront()](#pagebringtofront) * [page.browserContext()](#pagebrowsercontext)
- [page.browser()](#pagebrowser) * [page.click(selector[, options])](#pageclickselector-options)
- [page.browserContext()](#pagebrowsercontext) * [page.close([options])](#pagecloseoptions)
- [page.click(selector[, options])](#pageclickselector-options) * [page.content()](#pagecontent)
- [page.close([options])](#pagecloseoptions) * [page.cookies([...urls])](#pagecookiesurls)
- [page.content()](#pagecontent) * [page.coverage](#pagecoverage)
- [page.cookies([...urls])](#pagecookiesurls) * [page.dblclick(selector[, options])](#pagedblclickselector-options)
- [page.coverage](#pagecoverage) * [page.deleteCookie(...cookies)](#pagedeletecookiecookies)
- [page.dblclick(selector[, options])](#pagedblclickselector-options) * [page.emulate(options)](#pageemulateoptions)
- [page.deleteCookie(...cookies)](#pagedeletecookiecookies) * [page.emulateMedia(type)](#pageemulatemediatype)
- [page.emulate(options)](#pageemulateoptions) * [page.emulateMediaFeatures(features)](#pageemulatemediafeaturesfeatures)
- [page.emulateMedia(type)](#pageemulatemediatype) * [page.emulateMediaType(type)](#pageemulatemediatypetype)
- [page.emulateMediaFeatures(features)](#pageemulatemediafeaturesfeatures) * [page.emulateTimezone(timezoneId)](#pageemulatetimezonetimezoneid)
- [page.emulateMediaType(type)](#pageemulatemediatypetype) * [page.evaluate(pageFunction[, ...args])](#pageevaluatepagefunction-args)
- [page.emulateTimezone(timezoneId)](#pageemulatetimezonetimezoneid) * [page.evaluateHandle(pageFunction[, ...args])](#pageevaluatehandlepagefunction-args)
- [page.evaluate(pageFunction[, ...args])](#pageevaluatepagefunction-args) * [page.evaluateOnNewDocument(pageFunction[, ...args])](#pageevaluateonnewdocumentpagefunction-args)
- [page.evaluateHandle(pageFunction[, ...args])](#pageevaluatehandlepagefunction-args) * [page.exposeFunction(name, playwrightFunction)](#pageexposefunctionname-playwrightfunction)
- [page.evaluateOnNewDocument(pageFunction[, ...args])](#pageevaluateonnewdocumentpagefunction-args) * [page.fill(selector, value)](#pagefillselector-value)
- [page.exposeFunction(name, playwrightFunction)](#pageexposefunctionname-playwrightfunction) * [page.focus(selector)](#pagefocusselector)
- [page.fill(selector, value)](#pagefillselector-value) * [page.frames()](#pageframes)
- [page.focus(selector)](#pagefocusselector) * [page.goBack([options])](#pagegobackoptions)
- [page.frames()](#pageframes) * [page.goForward([options])](#pagegoforwardoptions)
- [page.goBack([options])](#pagegobackoptions) * [page.goto(url[, options])](#pagegotourl-options)
- [page.goForward([options])](#pagegoforwardoptions) * [page.hover(selector[, options])](#pagehoverselector-options)
- [page.goto(url[, options])](#pagegotourl-options) * [page.isClosed()](#pageisclosed)
- [page.hover(selector[, options])](#pagehoverselector-options) * [page.keyboard](#pagekeyboard)
- [page.isClosed()](#pageisclosed) * [page.mainFrame()](#pagemainframe)
- [page.keyboard](#pagekeyboard) * [page.metrics()](#pagemetrics)
- [page.mainFrame()](#pagemainframe) * [page.mouse](#pagemouse)
- [page.metrics()](#pagemetrics) * [page.queryObjects(prototypeHandle)](#pagequeryobjectsprototypehandle)
- [page.mouse](#pagemouse) * [page.reload([options])](#pagereloadoptions)
- [page.queryObjects(prototypeHandle)](#pagequeryobjectsprototypehandle) * [page.screenshot([options])](#pagescreenshotoptions)
- [page.reload([options])](#pagereloadoptions) * [page.select(selector, ...values)](#pageselectselector-values)
- [page.screenshot([options])](#pagescreenshotoptions) * [page.setBypassCSP(enabled)](#pagesetbypasscspenabled)
- [page.select(selector, ...values)](#pageselectselector-values) * [page.setCacheEnabled([enabled])](#pagesetcacheenabledenabled)
- [page.setBypassCSP(enabled)](#pagesetbypasscspenabled) * [page.setContent(html[, options])](#pagesetcontenthtml-options)
- [page.setCacheEnabled([enabled])](#pagesetcacheenabledenabled) * [page.setCookie(...cookies)](#pagesetcookiecookies)
- [page.setContent(html[, options])](#pagesetcontenthtml-options) * [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout)
- [page.setCookie(...cookies)](#pagesetcookiecookies) * [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout)
- [page.setDefaultNavigationTimeout(timeout)](#pagesetdefaultnavigationtimeouttimeout) * [page.setExtraHTTPHeaders(headers)](#pagesetextrahttpheadersheaders)
- [page.setDefaultTimeout(timeout)](#pagesetdefaulttimeouttimeout) * [page.setGeolocation(options)](#pagesetgeolocationoptions)
- [page.setExtraHTTPHeaders(headers)](#pagesetextrahttpheadersheaders) * [page.setJavaScriptEnabled(enabled)](#pagesetjavascriptenabledenabled)
- [page.setGeolocation(options)](#pagesetgeolocationoptions) * [page.setOfflineMode(enabled)](#pagesetofflinemodeenabled)
- [page.setJavaScriptEnabled(enabled)](#pagesetjavascriptenabledenabled) * [page.setRequestInterception(value)](#pagesetrequestinterceptionvalue)
- [page.setOfflineMode(enabled)](#pagesetofflinemodeenabled) * [page.setUserAgent(userAgent)](#pagesetuseragentuseragent)
- [page.setRequestInterception(value)](#pagesetrequestinterceptionvalue) * [page.setViewport(viewport)](#pagesetviewportviewport)
- [page.setUserAgent(userAgent)](#pagesetuseragentuseragent) * [page.tap(selector[, options])](#pagetapselector-options)
- [page.setViewport(viewport)](#pagesetviewportviewport) * [page.target()](#pagetarget)
- [page.tap(selector[, options])](#pagetapselector-options) * [page.title()](#pagetitle)
- [page.target()](#pagetarget) * [page.touchscreen](#pagetouchscreen)
- [page.title()](#pagetitle) * [page.tracing](#pagetracing)
- [page.touchscreen](#pagetouchscreen) * [page.tripleclick(selector[, options])](#pagetripleclickselector-options)
- [page.tracing](#pagetracing) * [page.type(selector, text[, options])](#pagetypeselector-text-options)
- [page.tripleclick(selector[, options])](#pagetripleclickselector-options) * [page.url()](#pageurl)
- [page.type(selector, text[, options])](#pagetypeselector-text-options) * [page.viewport()](#pageviewport)
- [page.url()](#pageurl) * [page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#pagewaitforselectororfunctionortimeout-options-args)
- [page.viewport()](#pageviewport) * [page.waitForFileChooser([options])](#pagewaitforfilechooseroptions)
- [page.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#pagewaitforselectororfunctionortimeout-options-args) * [page.waitForFunction(pageFunction[, options[, ...args]])](#pagewaitforfunctionpagefunction-options-args)
- [page.waitForFileChooser([options])](#pagewaitforfilechooseroptions) * [page.waitForNavigation([options])](#pagewaitfornavigationoptions)
- [page.waitForFunction(pageFunction[, options[, ...args]])](#pagewaitforfunctionpagefunction-options-args) * [page.waitForRequest(urlOrPredicate[, options])](#pagewaitforrequesturlorpredicate-options)
- [page.waitForNavigation([options])](#pagewaitfornavigationoptions) * [page.waitForResponse(urlOrPredicate[, options])](#pagewaitforresponseurlorpredicate-options)
- [page.waitForRequest(urlOrPredicate[, options])](#pagewaitforrequesturlorpredicate-options) * [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options)
- [page.waitForResponse(urlOrPredicate[, options])](#pagewaitforresponseurlorpredicate-options) * [page.waitForXPath(xpath[, options])](#pagewaitforxpathxpath-options)
- [page.waitForSelector(selector[, options])](#pagewaitforselectorselector-options) * [page.workers()](#pageworkers)
- [page.waitForXPath(xpath[, options])](#pagewaitforxpathxpath-options) - [class: Worker](#class-worker)
- [page.workers()](#pageworkers) * [worker.evaluate(pageFunction[, ...args])](#workerevaluatepagefunction-args)
- [class: Worker](#class-worker) * [worker.evaluateHandle(pageFunction[, ...args])](#workerevaluatehandlepagefunction-args)
- [worker.evaluate(pageFunction[, ...args])](#workerevaluatepagefunction-args) * [worker.executionContext()](#workerexecutioncontext)
- [worker.evaluateHandle(pageFunction[, ...args])](#workerevaluatehandlepagefunction-args) * [worker.url()](#workerurl)
- [worker.executionContext()](#workerexecutioncontext) - [class: Accessibility](#class-accessibility)
- [worker.url()](#workerurl) * [accessibility.snapshot([options])](#accessibilitysnapshotoptions)
- [class: Accessibility](#class-accessibility) - [class: Keyboard](#class-keyboard)
- [accessibility.snapshot([options])](#accessibilitysnapshotoptions) * [keyboard.down(key[, options])](#keyboarddownkey-options)
- [class: Keyboard](#class-keyboard) * [keyboard.press(key[, options])](#keyboardpresskey-options)
- [keyboard.down(key[, options])](#keyboarddownkey-options) * [keyboard.sendCharacter(char)](#keyboardsendcharacterchar)
- [keyboard.press(key[, options])](#keyboardpresskey-options) * [keyboard.type(text[, options])](#keyboardtypetext-options)
- [keyboard.sendCharacter(char)](#keyboardsendcharacterchar) * [keyboard.up(key)](#keyboardupkey)
- [keyboard.type(text[, options])](#keyboardtypetext-options) - [class: Mouse](#class-mouse)
- [keyboard.up(key)](#keyboardupkey) * [mouse.click(x, y[, options])](#mouseclickx-y-options)
- [class: Mouse](#class-mouse) * [mouse.dblclick(x, y[, options])](#mousedblclickx-y-options)
- [mouse.click(x, y[, options])](#mouseclickx-y-options) * [mouse.down([options])](#mousedownoptions)
- [mouse.dblclick(x, y[, options])](#mousedblclickx-y-options) * [mouse.move(x, y[, options])](#mousemovex-y-options)
- [mouse.down([options])](#mousedownoptions) * [mouse.tripleclick(x, y[, options])](#mousetripleclickx-y-options)
- [mouse.move(x, y[, options])](#mousemovex-y-options) * [mouse.up([options])](#mouseupoptions)
- [mouse.tripleclick(x, y[, options])](#mousetripleclickx-y-options) - [class: Touchscreen](#class-touchscreen)
- [mouse.up([options])](#mouseupoptions) * [touchscreen.tap(x, y)](#touchscreentapx-y)
- [class: Touchscreen](#class-touchscreen) - [class: Tracing](#class-tracing)
- [touchscreen.tap(x, y)](#touchscreentapx-y) * [tracing.start([options])](#tracingstartoptions)
- [class: Tracing](#class-tracing) * [tracing.stop()](#tracingstop)
- [tracing.start([options])](#tracingstartoptions) - [class: FileChooser](#class-filechooser)
- [tracing.stop()](#tracingstop) * [fileChooser.accept(filePaths)](#filechooseracceptfilepaths)
- [class: FileChooser](#class-filechooser) * [fileChooser.cancel()](#filechoosercancel)
- [fileChooser.accept(filePaths)](#filechooseracceptfilepaths) * [fileChooser.isMultiple()](#filechooserismultiple)
- [fileChooser.cancel()](#filechoosercancel) - [class: Dialog](#class-dialog)
- [fileChooser.isMultiple()](#filechooserismultiple) * [dialog.accept([promptText])](#dialogacceptprompttext)
- [class: Dialog](#class-dialog) * [dialog.defaultValue()](#dialogdefaultvalue)
- [dialog.accept([promptText])](#dialogacceptprompttext) * [dialog.dismiss()](#dialogdismiss)
- [dialog.defaultValue()](#dialogdefaultvalue) * [dialog.message()](#dialogmessage)
- [dialog.dismiss()](#dialogdismiss) * [dialog.type()](#dialogtype)
- [dialog.message()](#dialogmessage) - [class: ConsoleMessage](#class-consolemessage)
- [dialog.type()](#dialogtype) * [consoleMessage.args()](#consolemessageargs)
- [class: ConsoleMessage](#class-consolemessage) * [consoleMessage.location()](#consolemessagelocation)
- [consoleMessage.args()](#consolemessageargs) * [consoleMessage.text()](#consolemessagetext)
- [consoleMessage.location()](#consolemessagelocation) * [consoleMessage.type()](#consolemessagetype)
- [consoleMessage.text()](#consolemessagetext) - [class: Frame](#class-frame)
- [consoleMessage.type()](#consolemessagetype) * [frame.$(selector)](#frameselector)
- [class: Frame](#class-frame) * [frame.$$(selector)](#frameselector-1)
- [frame.$(selector)](#frameselector) * [frame.$$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args)
- [frame.$$(selector)](#frameselector) * [frame.$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args-1)
- [frame.$$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args) * [frame.$x(expression)](#framexexpression)
- [frame.$eval(selector, pageFunction[, ...args])](#frameevalselector-pagefunction-args) * [frame.addScriptTag(options)](#frameaddscripttagoptions)
- [frame.$x(expression)](#framexexpression) * [frame.addStyleTag(options)](#frameaddstyletagoptions)
- [frame.addScriptTag(options)](#frameaddscripttagoptions) * [frame.childFrames()](#framechildframes)
- [frame.addStyleTag(options)](#frameaddstyletagoptions) * [frame.click(selector[, options])](#frameclickselector-options)
- [frame.childFrames()](#framechildframes) * [frame.content()](#framecontent)
- [frame.click(selector[, options])](#frameclickselector-options) * [frame.dblclick(selector[, options])](#framedblclickselector-options)
- [frame.content()](#framecontent) * [frame.evaluate(pageFunction[, ...args])](#frameevaluatepagefunction-args)
- [frame.dblclick(selector[, options])](#framedblclickselector-options) * [frame.evaluateHandle(pageFunction[, ...args])](#frameevaluatehandlepagefunction-args)
- [frame.evaluate(pageFunction[, ...args])](#frameevaluatepagefunction-args) * [frame.executionContext()](#frameexecutioncontext)
- [frame.evaluateHandle(pageFunction[, ...args])](#frameevaluatehandlepagefunction-args) * [frame.fill(selector, value)](#framefillselector-value)
- [frame.executionContext()](#frameexecutioncontext) * [frame.focus(selector)](#framefocusselector)
- [frame.fill(selector, value)](#framefillselector-value) * [frame.goto(url[, options])](#framegotourl-options)
- [frame.focus(selector)](#framefocusselector) * [frame.hover(selector[, options])](#framehoverselector-options)
- [frame.goto(url[, options])](#framegotourl-options) * [frame.isDetached()](#frameisdetached)
- [frame.hover(selector[, options])](#framehoverselector-options) * [frame.name()](#framename)
- [frame.isDetached()](#frameisdetached) * [frame.parentFrame()](#frameparentframe)
- [frame.name()](#framename) * [frame.select(selector, ...values)](#frameselectselector-values)
- [frame.parentFrame()](#frameparentframe) * [frame.setContent(html[, options])](#framesetcontenthtml-options)
- [frame.select(selector, ...values)](#frameselectselector-values) * [frame.tap(selector[, options])](#frametapselector-options)
- [frame.setContent(html[, options])](#framesetcontenthtml-options) * [frame.title()](#frametitle)
- [frame.tap(selector[, options])](#frametapselector-options) * [frame.tripleclick(selector[, options])](#frametripleclickselector-options)
- [frame.title()](#frametitle) * [frame.type(selector, text[, options])](#frametypeselector-text-options)
- [frame.tripleclick(selector[, options])](#frametripleclickselector-options) * [frame.url()](#frameurl)
- [frame.type(selector, text[, options])](#frametypeselector-text-options) * [frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#framewaitforselectororfunctionortimeout-options-args)
- [frame.url()](#frameurl) * [frame.waitForFunction(pageFunction[, options[, ...args]])](#framewaitforfunctionpagefunction-options-args)
- [frame.waitFor(selectorOrFunctionOrTimeout[, options[, ...args]])](#framewaitforselectororfunctionortimeout-options-args) * [frame.waitForNavigation([options])](#framewaitfornavigationoptions)
- [frame.waitForFunction(pageFunction[, options[, ...args]])](#framewaitforfunctionpagefunction-options-args) * [frame.waitForSelector(selector[, options])](#framewaitforselectorselector-options)
- [frame.waitForNavigation([options])](#framewaitfornavigationoptions) * [frame.waitForXPath(xpath[, options])](#framewaitforxpathxpath-options)
- [frame.waitForSelector(selector[, options])](#framewaitforselectorselector-options) - [class: ExecutionContext](#class-executioncontext)
- [frame.waitForXPath(xpath[, options])](#framewaitforxpathxpath-options) * [executionContext.evaluate(pageFunction[, ...args])](#executioncontextevaluatepagefunction-args)
- [class: ExecutionContext](#class-executioncontext) * [executionContext.evaluateHandle(pageFunction[, ...args])](#executioncontextevaluatehandlepagefunction-args)
- [executionContext.evaluate(pageFunction[, ...args])](#executioncontextevaluatepagefunction-args) * [executionContext.frame()](#executioncontextframe)
- [executionContext.evaluateHandle(pageFunction[, ...args])](#executioncontextevaluatehandlepagefunction-args) * [executionContext.queryObjects(prototypeHandle)](#executioncontextqueryobjectsprototypehandle)
- [executionContext.frame()](#executioncontextframe) - [class: JSHandle](#class-jshandle)
- [executionContext.queryObjects(prototypeHandle)](#executioncontextqueryobjectsprototypehandle) * [jsHandle.asElement()](#jshandleaselement)
- [class: JSHandle](#class-jshandle) * [jsHandle.dispose()](#jshandledispose)
- [jsHandle.asElement()](#jshandleaselement) * [jsHandle.evaluate(pageFunction[, ...args])](#jshandleevaluatepagefunction-args)
- [jsHandle.dispose()](#jshandledispose) * [jsHandle.evaluateHandle(pageFunction[, ...args])](#jshandleevaluatehandlepagefunction-args)
- [jsHandle.evaluate(pageFunction[, ...args])](#jshandleevaluatepagefunction-args) * [jsHandle.executionContext()](#jshandleexecutioncontext)
- [jsHandle.evaluateHandle(pageFunction[, ...args])](#jshandleevaluatehandlepagefunction-args) * [jsHandle.getProperties()](#jshandlegetproperties)
- [jsHandle.executionContext()](#jshandleexecutioncontext) * [jsHandle.getProperty(propertyName)](#jshandlegetpropertypropertyname)
- [jsHandle.getProperties()](#jshandlegetproperties) * [jsHandle.jsonValue()](#jshandlejsonvalue)
- [jsHandle.getProperty(propertyName)](#jshandlegetpropertypropertyname) - [class: ElementHandle](#class-elementhandle)
- [jsHandle.jsonValue()](#jshandlejsonvalue) * [elementHandle.$(selector)](#elementhandleselector)
- [class: ElementHandle](#class-elementhandle) * [elementHandle.$$(selector)](#elementhandleselector-1)
- [elementHandle.$(selector)](#elementhandleselector) * [elementHandle.$$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args)
- [elementHandle.$$(selector)](#elementhandleselector) * [elementHandle.$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args-1)
- [elementHandle.$$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args) * [elementHandle.$x(expression)](#elementhandlexexpression)
- [elementHandle.$eval(selector, pageFunction[, ...args])](#elementhandleevalselector-pagefunction-args) * [elementHandle.asElement()](#elementhandleaselement)
- [elementHandle.$x(expression)](#elementhandlexexpression) * [elementHandle.boundingBox()](#elementhandleboundingbox)
- [elementHandle.asElement()](#elementhandleaselement) * [elementHandle.boxModel()](#elementhandleboxmodel)
- [elementHandle.boundingBox()](#elementhandleboundingbox) * [elementHandle.click([options])](#elementhandleclickoptions)
- [elementHandle.boxModel()](#elementhandleboxmodel) * [elementHandle.contentFrame()](#elementhandlecontentframe)
- [elementHandle.click([options])](#elementhandleclickoptions) * [elementHandle.dblclick([options])](#elementhandledblclickoptions)
- [elementHandle.contentFrame()](#elementhandlecontentframe) * [elementHandle.dispose()](#elementhandledispose)
- [elementHandle.dblclick([options])](#elementhandledblclickoptions) * [elementHandle.evaluate(pageFunction[, ...args])](#elementhandleevaluatepagefunction-args)
- [elementHandle.dispose()](#elementhandledispose) * [elementHandle.evaluateHandle(pageFunction[, ...args])](#elementhandleevaluatehandlepagefunction-args)
- [elementHandle.evaluate(pageFunction[, ...args])](#elementhandleevaluatepagefunction-args) * [elementHandle.executionContext()](#elementhandleexecutioncontext)
- [elementHandle.evaluateHandle(pageFunction[, ...args])](#elementhandleevaluatehandlepagefunction-args) * [elementHandle.fill(value)](#elementhandlefillvalue)
- [elementHandle.executionContext()](#elementhandleexecutioncontext) * [elementHandle.focus()](#elementhandlefocus)
- [elementHandle.fill(value)](#elementhandlefillvalue) * [elementHandle.getProperties()](#elementhandlegetproperties)
- [elementHandle.focus()](#elementhandlefocus) * [elementHandle.getProperty(propertyName)](#elementhandlegetpropertypropertyname)
- [elementHandle.getProperties()](#elementhandlegetproperties) * [elementHandle.hover([options])](#elementhandlehoveroptions)
- [elementHandle.getProperty(propertyName)](#elementhandlegetpropertypropertyname) * [elementHandle.isIntersectingViewport()](#elementhandleisintersectingviewport)
- [elementHandle.hover([options])](#elementhandlehoveroptions) * [elementHandle.jsonValue()](#elementhandlejsonvalue)
- [elementHandle.isIntersectingViewport()](#elementhandleisintersectingviewport) * [elementHandle.press(key[, options])](#elementhandlepresskey-options)
- [elementHandle.jsonValue()](#elementhandlejsonvalue) * [elementHandle.screenshot([options])](#elementhandlescreenshotoptions)
- [elementHandle.press(key[, options])](#elementhandlepresskey-options) * [elementHandle.select(...values)](#elementhandleselectvalues)
- [elementHandle.screenshot([options])](#elementhandlescreenshotoptions) * [elementHandle.tap([options])](#elementhandletapoptions)
- [elementHandle.select(...values)](#elementhandleselectvalues) * [elementHandle.toString()](#elementhandletostring)
- [elementHandle.tap([options])](#elementhandletapoptions) * [elementHandle.tripleclick([options])](#elementhandletripleclickoptions)
- [elementHandle.toString()](#elementhandletostring) * [elementHandle.type(text[, options])](#elementhandletypetext-options)
- [elementHandle.tripleclick([options])](#elementhandletripleclickoptions) * [elementHandle.uploadFile(...filePaths)](#elementhandleuploadfilefilepaths)
- [elementHandle.type(text[, options])](#elementhandletypetext-options) - [class: Request](#class-request)
- [elementHandle.uploadFile(...filePaths)](#elementhandleuploadfilefilepaths) * [request.abort([errorCode])](#requestaborterrorcode)
- [class: Request](#class-request) * [request.continue([overrides])](#requestcontinueoverrides)
- [request.abort([errorCode])](#requestaborterrorcode) * [request.failure()](#requestfailure)
- [request.continue([overrides])](#requestcontinueoverrides) * [request.frame()](#requestframe)
- [request.failure()](#requestfailure) * [request.headers()](#requestheaders)
- [request.frame()](#requestframe) * [request.isNavigationRequest()](#requestisnavigationrequest)
- [request.headers()](#requestheaders) * [request.method()](#requestmethod)
- [request.isNavigationRequest()](#requestisnavigationrequest) * [request.postData()](#requestpostdata)
- [request.method()](#requestmethod) * [request.redirectChain()](#requestredirectchain)
- [request.postData()](#requestpostdata) * [request.resourceType()](#requestresourcetype)
- [request.redirectChain()](#requestredirectchain) * [request.respond(response)](#requestrespondresponse)
- [request.resourceType()](#requestresourcetype) * [request.response()](#requestresponse)
- [request.respond(response)](#requestrespondresponse) * [request.url()](#requesturl)
- [request.response()](#requestresponse) - [class: Response](#class-response)
- [request.url()](#requesturl) * [response.buffer()](#responsebuffer)
- [class: Response](#class-response) * [response.frame()](#responseframe)
- [response.buffer()](#responsebuffer) * [response.fromCache()](#responsefromcache)
- [response.frame()](#responseframe) * [response.fromServiceWorker()](#responsefromserviceworker)
- [response.fromCache()](#responsefromcache) * [response.headers()](#responseheaders)
- [response.fromServiceWorker()](#responsefromserviceworker) * [response.json()](#responsejson)
- [response.headers()](#responseheaders) * [response.ok()](#responseok)
- [response.json()](#responsejson) * [response.remoteAddress()](#responseremoteaddress)
- [response.ok()](#responseok) * [response.request()](#responserequest)
- [response.remoteAddress()](#responseremoteaddress) * [response.securityDetails()](#responsesecuritydetails)
- [response.request()](#responserequest) * [response.status()](#responsestatus)
- [response.securityDetails()](#responsesecuritydetails) * [response.statusText()](#responsestatustext)
- [response.status()](#responsestatus) * [response.text()](#responsetext)
- [response.statusText()](#responsestatustext) * [response.url()](#responseurl)
- [response.text()](#responsetext) - [class: SecurityDetails](#class-securitydetails)
- [response.url()](#responseurl) * [securityDetails.issuer()](#securitydetailsissuer)
- [class: SecurityDetails](#class-securitydetails) * [securityDetails.protocol()](#securitydetailsprotocol)
- [securityDetails.issuer()](#securitydetailsissuer) * [securityDetails.subjectName()](#securitydetailssubjectname)
- [securityDetails.protocol()](#securitydetailsprotocol) * [securityDetails.validFrom()](#securitydetailsvalidfrom)
- [securityDetails.subjectName()](#securitydetailssubjectname) * [securityDetails.validTo()](#securitydetailsvalidto)
- [securityDetails.validFrom()](#securitydetailsvalidfrom) - [class: Target](#class-target)
- [securityDetails.validTo()](#securitydetailsvalidto) * [target.browser()](#targetbrowser)
- [class: Target](#class-target) * [target.browserContext()](#targetbrowsercontext)
- [target.browser()](#targetbrowser) * [target.createCDPSession()](#targetcreatecdpsession)
- [target.browserContext()](#targetbrowsercontext) * [target.opener()](#targetopener)
- [target.createCDPSession()](#targetcreatecdpsession) * [target.page()](#targetpage)
- [target.opener()](#targetopener) * [target.type()](#targettype)
- [target.page()](#targetpage) * [target.url()](#targeturl)
- [target.type()](#targettype) * [target.worker()](#targetworker)
- [target.url()](#targeturl) - [class: CDPSession](#class-cdpsession)
- [target.worker()](#targetworker) * [cdpSession.detach()](#cdpsessiondetach)
- [class: CDPSession](#class-cdpsession) * [cdpSession.send(method[, params])](#cdpsessionsendmethod-params)
- [cdpSession.detach()](#cdpsessiondetach) - [class: Coverage](#class-coverage)
- [cdpSession.send(method[, params])](#cdpsessionsendmethod-params) * [coverage.startCSSCoverage([options])](#coveragestartcsscoverageoptions)
- [class: Coverage](#class-coverage) * [coverage.startJSCoverage([options])](#coveragestartjscoverageoptions)
- [coverage.startCSSCoverage([options])](#coveragestartcsscoverageoptions) * [coverage.stopCSSCoverage()](#coveragestopcsscoverage)
- [coverage.startJSCoverage([options])](#coveragestartjscoverageoptions) * [coverage.stopJSCoverage()](#coveragestopjscoverage)
- [coverage.stopCSSCoverage()](#coveragestopcsscoverage) - [class: TimeoutError](#class-timeouterror)
- [coverage.stopJSCoverage()](#coveragestopjscoverage)
- [class: TimeoutError](#class-timeouterror)
<!-- GEN:stop --> <!-- GEN:stop -->
### Overview ### Overview

View file

@ -56,7 +56,7 @@ export class BrowserContext extends EventEmitter {
return !!this._id; return !!this._id;
} }
async overridePermissions(origin: string, userPermissions: string[]) { async overridePermissions(origin: string, permissions: string[]) {
const webPermissionToProtocol = new Map<string, Protocol.Browser.PermissionType>([ const webPermissionToProtocol = new Map<string, Protocol.Browser.PermissionType>([
['geolocation', 'geolocation'], ['geolocation', 'geolocation'],
['midi', 'midi'], ['midi', 'midi'],
@ -75,13 +75,13 @@ export class BrowserContext extends EventEmitter {
// chrome-specific permissions we have. // chrome-specific permissions we have.
['midi-sysex', 'midiSysex'], ['midi-sysex', 'midiSysex'],
]); ]);
const permissions = userPermissions.map(permission => { const filtered = permissions.map(permission => {
const protocolPermission = webPermissionToProtocol.get(permission); const protocolPermission = webPermissionToProtocol.get(permission);
if (!protocolPermission) if (!protocolPermission)
throw new Error('Unknown permission: ' + permission); throw new Error('Unknown permission: ' + permission);
return protocolPermission; return protocolPermission;
}); });
await this._connection.send('Browser.grantPermissions', {origin, browserContextId: this._id || undefined, permissions}); await this._connection.send('Browser.grantPermissions', {origin, browserContextId: this._id || undefined, permissions: filtered});
} }
async clearPermissionOverrides() { async clearPermissionOverrides() {

View file

@ -15,7 +15,7 @@
* limitations under the License. * limitations under the License.
*/ */
const playwright = require('../..'); const playwright = require('../../chromium');
const path = require('path'); const path = require('path');
const Source = require('./Source'); const Source = require('./Source');
@ -38,10 +38,8 @@ async function run() {
// Documentation checks. // Documentation checks.
{ {
const readme = await Source.readFile(path.join(PROJECT_DIR, 'README.md')); const readme = await Source.readFile(path.join(PROJECT_DIR, 'README.md'));
const contributing = await Source.readFile(path.join(PROJECT_DIR, 'CONTRIBUTING.md'));
const api = await Source.readFile(path.join(PROJECT_DIR, 'docs', 'api.md')); const api = await Source.readFile(path.join(PROJECT_DIR, 'docs', 'api.md'));
const troubleshooting = await Source.readFile(path.join(PROJECT_DIR, 'docs', 'troubleshooting.md')); const mdSources = [readme, api];
const mdSources = [readme, api, troubleshooting, contributing];
const preprocessor = require('./preprocessor'); const preprocessor = require('./preprocessor');
messages.push(...await preprocessor.runCommands(mdSources, VERSION)); messages.push(...await preprocessor.runCommands(mdSources, VERSION));