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