fix up jsdoc

This commit is contained in:
Joel Einbinder 2017-07-14 14:55:53 -07:00
parent ee61ca0f00
commit af7cd869e4
3 changed files with 17 additions and 19 deletions

View File

@ -13,8 +13,8 @@
* [browser.stdout](#browserstdout)
* [browser.version()](#browserversion)
- [class: Page](#class-page)
* [page.$(selector, pageFunction, ...args)](#pageselector-fun-args)
* [page.$$(selector, pageFunction, ...args)](#pageselector-fun-args)
* [page.$(selector, pageFunction, ...args)](#pageselector-pagefunction-args)
* [page.$$(selector, pageFunction, ...args)](#pageselector-pagefunction-args)
* [page.addScriptTag(url)](#pageaddscripttagurl)
* [page.click(selector)](#pageclickselector)
* [page.close()](#pageclose)
@ -48,8 +48,8 @@
* [dialog.message()](#dialogmessage)
* [dialog.type](#dialogtype)
- [class: Frame](#class-frame)
* [frame.$(selector, pageFunction, ...args)](#frameselector-fun-args)
* [frame.$$(selector, pageFunction, ...args)](#frameselector-fun-args)
* [frame.$(selector, pageFunction, ...args)](#frameselector-pagefunction-args)
* [frame.$$(selector, pageFunction, ...args)](#frameselector-pagefunction-args)
* [frame.childFrames()](#framechildframes)
* [frame.evaluate(pageFunction, ...args)](#frameevaluatepagefunction-args)
* [frame.isDetached()](#frameisdetached)
@ -212,8 +212,6 @@ for (const heading of headings) console.log(heading);
Shortcut for [page.mainFrame().$$(selector, pageFunction, ...args)](#pageselector-fun-args).
#### page.addScriptTag(url)
#### page.addScriptTag(url)
- `url` <[string]> Url of a script to be added
- returns: <[Promise]> Promise which resolves as the script gets added and loads.

View File

@ -263,7 +263,7 @@ class Frame {
* @param {!Array<*>} args
* @return {!Promise<(!Object|undefined)>}
*/
async evaluate(fun, ...args) {
async evaluate(pageFunction, ...args) {
return this._frameManager._evaluateOnFrame(this, helper.evaluationString(pageFunction, ...args));
}
@ -319,32 +319,32 @@ class Frame {
/**
* @param {string} selector
* @param {function(!Element):T} fun
* @param {function(!Element):T} pageFunction
* @param {!Array<*>} args
* @return {!Promise<?T>}
*/
async $(selector, fun, ...args) {
async $(selector, pageFunction, ...args) {
let argsString = ['node'].concat(args.map(x => JSON.stringify(x))).join(',');
let expression = `(()=>{
let node = document.querySelector(${JSON.stringify(selector)});
if (!node)
return null;
return (${fun})(${argsString});
return (${pageFunction})(${argsString});
})()`;
return this._frameManager._evaluateOnFrame(this, expression);
}
/**
* @param {string} selector
* @param {function(!Element):T} fun
* @param {function(!Element):T} pageFunction
* @param {!Array<*>} args
* @return {!Promise<!Array<T>>}
*/
async $$(selector, fun, ...args) {
async $$(selector, pageFunction, ...args) {
let argsString = ['node, index'].concat(args.map(x => JSON.stringify(x))).join(',');
let expression = `(()=>{
let nodes = document.querySelectorAll(${JSON.stringify(selector)});
return Array.prototype.map.call(nodes, (node, index) => (${fun})(${argsString}));
return Array.prototype.map.call(nodes, (node, index) => (${pageFunction})(${argsString}));
})()`;
return this._frameManager._evaluateOnFrame(this, expression);
}

View File

@ -605,22 +605,22 @@ class Page extends EventEmitter {
/**
* @param {string} selector
* @param {function(!Element):T} fun
* @param {function(!Element):T} pageFunction
* @param {!Array<*>} args
* @return {!Promise<?T>}
*/
async $(selector, fun, ...args) {
return this.mainFrame().$(selector, fun, ...args);
async $(selector, pageFunction, ...args) {
return this.mainFrame().$(selector, pageFunction, ...args);
}
/**
* @param {string} selector
* @param {function(!Element):T} fun
* @param {function(!Element):T} pageFunction
* @param {!Array<*>} args
* @return {!Promise<!Array<T>>}
*/
async $$(selector, fun, ...args) {
return this.mainFrame().$$(selector, fun, ...args);
async $$(selector, pageFunction, ...args) {
return this.mainFrame().$$(selector, pageFunction, ...args);
}
}