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

add stubs for methods in api.md

Browse Source 
References #14
This commit is contained in:
Andrey Lushnikov 2017-06-27 12:15:21 -07:00
parent 9508396e3e
commit 4b0b3b5ff5
1 changed files with 199 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
docs/api.md
View File

@ -1,31 +1,62 @@
# Puppeteer API # Puppeteer API
- [class: Browser](#class-browser) ##### Table of Contents
- [new Browser([options])](#new-browseroptions)
- [browser.newPage()](#browsernewpage) + [class: Browser](#class-browser)
- [browser.closePage()](#browserclosepage) - [new Browser([options])](#new-browseroptions)
- [browser.version()](#browserversion) - [browser.close()](#browserclose)
- [browser.close()](#browserclose) - [browser.closePage()](#browserclosepage)
- [class: Page](#class-page) - [browser.newPage()](#browsernewpage)
- [page.addScriptTag(url)](#pageaddscripttagurl) - [browser.version()](#browserversion)
- [page.injectFile(filePath)](#pageinjectfilefilepath) + [class: Page](#class-page)
- [page.setInPageCallback(name, callback)](#pagesetinpagecallbackname-callback) - [page.addScriptTag(url)](#pageaddscripttagurl)
- [page.setExtraHTTPHeaders(headers)](#pagesetextrahttpheadersheaders) - [page.close()](#pageclose)
- [page.extraHTTPHeaders()](#pageextrahttpheaders) - [page.evaluate(fun, args)](#pageevaluatefun-args)
- [page.setUserAgentOverride(userAgent)](#pagesetuseragentoverrideuseragent) - [page.evaluateOnInitialized(fun, args)](#pageevaluateoninitializedfun-args)
- [page.userAgentOverride()](#pageuseragentoverride) - [page.extraHTTPHeaders()](#pageextrahttpheaders)
- [page.url()](#pageurl) - [page.frames()](#pageframes)
- [page.setContent(html)](#pagesetcontenthtml) - [page.injectFile(filePath)](#pageinjectfilefilepath)
- [page.navigate(url)](#pagenavigateurl) - [page.mainFrame()](#pagemainframe)
- [page.setViewportSize(size)](#pagesetsizesize) - [page.navigate(url)](#pagenavigateurl)
- [page.viewportSize()](#pagesize) - [page.plainText()](#pageplaintext)
- [page.evaluate(fun, args)](#pageevaluatefun-args) - [page.printToPDF(filePath[, options])](#pageprinttopdffilepath-options)
- [page.evaluateOnInitialized(fun, args)](#pageevaluateoninitializedfun-args) - [page.screenshot([options])](#pagescreenshotoptions)
- [page.screenshot(\[options\])](#pagescreenshottype-cliprect) - [page.setContent(html)](#pagesetcontenthtml)
- [page.printToPDF(filePath[, options])](#pageprinttopdffilepath-options) - [page.setExtraHTTPHeaders(headers)](#pagesetextrahttpheadersheaders)
- [page.plainText()](#pageplaintext) - [page.setInPageCallback(name, callback)](#pagesetinpagecallbackname-callback)
- [page.title()](#pagetitle) - [page.setRequestInterceptor()](#pagesetrequestinterceptor)
- [page.close()](#pageclose) - [page.setUserAgentOverride(userAgent)](#pagesetuseragentoverrideuseragent)
- [page.setViewportSize(size)](#pagesetviewportsizesize)
- [page.title()](#pagetitle)
- [page.url()](#pageurl)
- [page.userAgentOverride()](#pageuseragentoverride)
- [page.viewportSize()](#pageviewportsize)
+ [class: Dialog](#class-dialog)
- [dialog.accept()](#dialogaccept)
- [dialog.dismiss()](#dialogdismiss)
- [dialog.message()](#dialogmessage)
+ [class: Frame](#class-frame)
- [frame.childFrames()](#framechildframes)
- [frame.isDetached()](#frameisdetached)
- [frame.isMainFrame()](#frameismainframe)
- [frame.name()](#framename)
- [frame.parentFrame()](#frameparentframe)
- [frame.securityOrigin()](#framesecurityorigin)
- [frame.url()](#frameurl)
+ [class: Request](#class-request)
- [new Request()](#new-request)
- [request.abort()](#requestabort)
- [request.continue()](#requestcontinue)
- [request.handled()](#requesthandled)
- [request.headers()](#requestheaders)
- [request.method()](#requestmethod)
- [request.method()](#requestmethod-1)
- [request.postData()](#requestpostdata)
- [request.setHeader()](#requestsetheader)
- [request.setMethod()](#requestsetmethod)
- [request.setPostData()](#requestsetpostdata)
- [request.setUrl()](#requestseturl)
- [request.url()](#requesturl)
### class: Browser ### class: Browser
@ -41,24 +72,25 @@ not necessarily result in launching browser; the instance will be launched when
- `executablePath` <[string]> Path to a chromium executable to run instead of bundled chromium. - `executablePath` <[string]> Path to a chromium executable to run instead of bundled chromium.
- `args` <[Array]<[string]>> Additional arguments to pass to the chromium instance. List of chromium flags could be found [here](http://peter.sh/experiments/chromium-command-line-switches/). - `args` <[Array]<[string]>> Additional arguments to pass to the chromium instance. List of chromium flags could be found [here](http://peter.sh/experiments/chromium-command-line-switches/).
#### browser.close()
Closes chromium application with all the pages (if any were opened). The browser object itself is considered to be disposed and could not be used anymore.
#### browser.closePage()
- returns: <[Promise]>
#### browser.newPage() #### browser.newPage()
- returns: <[Promise]<[Page]>> - returns: <[Promise]<[Page]>>
Create a new page in browser and returns a promise which gets resolved with a Page object. Create a new page in browser and returns a promise which gets resolved with a Page object.
#### browser.closePage()
- returns: <[Promise]>
#### browser.version() #### browser.version()
- returns: <[Promise]<[string]>> - returns: <[Promise]<[string]>>
#### browser.close()
Closes chromium application with all the pages (if any were opened). The browser object itself is considered to be disposed and could not be used anymore.
### class: Page ### class: Page
Page provides interface to interact with a tab in a browser. Pages are created by browser: Page provides interface to interact with a tab in a browser. Pages are created by browser:
@ -76,63 +108,9 @@ Pages could be closed by `page.close()` method.
- `url` <[string]> Url of a script to be added - `url` <[string]> Url of a script to be added
- returns: <[Promise]> Promise which resolves as the script gets added and loads. - returns: <[Promise]> Promise which resolves as the script gets added and loads.
#### page.injectFile(filePath) #### page.close()
- `url` <[string]> Path to the javascript file to be injected into page. - returns: <[Promise]> Returns promise which resolves when page gets closed.
- returns: <[Promise]> Promise which resolves when file gets successfully evaluated in page.
#### page.setInPageCallback(name, callback)
- `url` <[string]> Name of the callback to be assigned on window object
- `callback` <[function]> Callback function which will be called in node.js
- returns: <[Promise]> Promise which resolves when callback is successfully initialized
#### page.setExtraHTTPHeaders(headers)
- `headers` <[Object]> Key-value set of additional http headers to be sent with every request.
- returns: <[Promise]> Promise which resolves when additional headers are installed
#### page.extraHTTPHeaders()
- returns: <[Object]> Key-value set of additional http headers, which will be sent with every request.
#### page.setUserAgentOverride(userAgent)
- `userAgent` <[string]> Specific user agent to use in this page
- returns: <[Promise]> Promise which resolves when the user agent is set.
#### page.userAgentOverride()
- returns: <[string]> Returns user agent override, if any.
#### page.url()
- returns: <[Promise]<[string]>> Promise which resolves with the current page url.
#### page.setContent(html)
- `html` <[string]> HTML markup to assign to the page.
- returns: <[Promise]> Promise which resolves when the content is successfully assigned.
#### page.navigate(url)
- `url` <[string]> URL to navigate page to
- returns: <[Promise]<[boolean]>> Promise which resolves when the page is navigated. The promise resolves to:
- `true` if the navigation succeeds and page's `load` event is fired.
- `false` if the navigation fails due to bad URL or SSL errors.
#### page.setViewportSize(size)
- `size` <[Object]> An object with two fields:
- `width` <[number]> Specify page's width in pixels.
- `height` <[number]> Specify page's height in pixels.
- returns: <[Promise]> Promise which resolves when the dimensions are updated.
#### page.viewportSize()
- returns: <[Object]> An object with two fields:
- `width` <[number]> Page's width in pixels.
- `height` <[number]> Page's height in pixels.
#### page.evaluate(fun, args) #### page.evaluate(fun, args)
@ -146,19 +124,30 @@ Pages could be closed by `page.close()` method.
- `args` <[Array]<[string]>> Arguments to pass to `fun` - `args` <[Array]<[string]>> Arguments to pass to `fun`
- returns: <[Promise]<[Object]>> Promise which resolves to function - returns: <[Promise]<[Object]>> Promise which resolves to function
#### page.screenshot([options]) #### page.extraHTTPHeaders()
- `options` <[Object]> Options object which might have the following properties: - returns: <[Object]> Key-value set of additional http headers, which will be sent with every request.
- `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension.
- `type` <[string]> Specify screenshot type, could be either `jpeg` or `png`.
- `quality` <[number]> The quality of the image, between 0-100. Not applicable to `.jpg` images. #### page.frames()
- `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page.
- `clip` <[Object]> An object which specifies clipping region of the page. Should have the following fields: #### page.injectFile(filePath)
- `x` <[number]> x-coordinate of top-left corner of clip area
- `y` <[number]> y-coordinate of top-left corner of clip area - `url` <[string]> Path to the javascript file to be injected into page.
- `width` <[number]> width of clipping area - returns: <[Promise]> Promise which resolves when file gets successfully evaluated in page.
- `height` <[number]> height of clipping area
- returns: <[Promise]<[Buffer]>> Promise which resolves to buffer with captured screenshot #### page.mainFrame()
#### page.navigate(url)
- `url` <[string]> URL to navigate page to
- returns: <[Promise]<[boolean]>> Promise which resolves when the page is navigated. The promise resolves to:
- `true` if the navigation succeeds and page's `load` event is fired.
- `false` if the navigation fails due to bad URL or SSL errors.
#### page.plainText()
- returns: <[Promise]<[string]>> Returns page's inner text.
#### page.printToPDF(filePath[, options]) #### page.printToPDF(filePath[, options])
@ -174,17 +163,121 @@ Pages could be closed by `page.close()` method.
- `height` <[number]> - `height` <[number]>
- returns: <[Promise]> Promise which resolves when the PDF is saved. - returns: <[Promise]> Promise which resolves when the PDF is saved.
#### page.plainText() #### page.screenshot([options])
- returns: <[Promise]<[string]>> Returns page's inner text. - `options` <[Object]> Options object which might have the following properties:
- `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension.
- `type` <[string]> Specify screenshot type, could be either `jpeg` or `png`.
- `quality` <[number]> The quality of the image, between 0-100. Not applicable to `.jpg` images.
- `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page.
- `clip` <[Object]> An object which specifies clipping region of the page. Should have the following fields:
- `x` <[number]> x-coordinate of top-left corner of clip area
- `y` <[number]> y-coordinate of top-left corner of clip area
- `width` <[number]> width of clipping area
- `height` <[number]> height of clipping area
- returns: <[Promise]<[Buffer]>> Promise which resolves to buffer with captured screenshot
#### page.setContent(html)
- `html` <[string]> HTML markup to assign to the page.
- returns: <[Promise]> Promise which resolves when the content is successfully assigned.
#### page.setExtraHTTPHeaders(headers)
- `headers` <[Object]> Key-value set of additional http headers to be sent with every request.
- returns: <[Promise]> Promise which resolves when additional headers are installed
#### page.setInPageCallback(name, callback)
- `url` <[string]> Name of the callback to be assigned on window object
- `callback` <[function]> Callback function which will be called in node.js
- returns: <[Promise]> Promise which resolves when callback is successfully initialized
#### page.setRequestInterceptor()
#### page.setUserAgentOverride(userAgent)
- `userAgent` <[string]> Specific user agent to use in this page
- returns: <[Promise]> Promise which resolves when the user agent is set.
#### page.setViewportSize(size)
- `size` <[Object]> An object with two fields:
- `width` <[number]> Specify page's width in pixels.
- `height` <[number]> Specify page's height in pixels.
- returns: <[Promise]> Promise which resolves when the dimensions are updated.
#### page.title() #### page.title()
- returns: <[Promise]<[string]>> Returns page's title. - returns: <[Promise]<[string]>> Returns page's title.
#### page.close()
- returns: <[Promise]> Returns promise which resolves when page gets closed. #### page.url()
- returns: <[Promise]<[string]>> Promise which resolves with the current page url.
#### page.userAgentOverride()
- returns: <[string]> Returns user agent override, if any.
#### page.viewportSize()
- returns: <[Object]> An object with two fields:
- `width` <[number]> Page's width in pixels.
- `height` <[number]> Page's height in pixels.
### class: Dialog
#### dialog.accept()
#### dialog.dismiss()
#### dialog.message()
### class: Frame
#### frame.childFrames()
#### frame.isDetached()
#### frame.isMainFrame()
#### frame.name()
#### frame.parentFrame()
#### frame.securityOrigin()
#### frame.url()
### class: Request
#### new Request()
#### request.abort()
#### request.continue()
#### request.handled()
#### request.headers()
#### request.method()
#### request.method()
#### request.postData()
#### request.setHeader()
#### request.setMethod()
#### request.setPostData()
#### request.setUrl()
#### request.url()
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array" [Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean" [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"