Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Fix typings for several ElementArrayFinder methods #4671

Open
inad9300 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typings for several ElementArrayFinder methods #4671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions lib/element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ export class ElementArrayFinder extends WebdriverWebElement {
* of element that satisfy the filter function.
*/
filter(
filterFn: (element: ElementFinder, index?: number) => boolean |
filterFn: (element: ElementFinder, index: number) => boolean |
Copy link
Copy Markdown

@tymfear tymfear Jan 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does the index parameter should be required?

Copy link
Copy Markdown
Author

@inad9300 inad9300 Jan 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the question mark does not mean that you are forced to accept index as a parameter in your callback. This is the whole point of #4634.

Copy link
Copy Markdown

@tymfear tymfear Jan 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha! Thanks a lot!

wdpromise.Promise<boolean>): ElementArrayFinder {
let getWebElements = (): wdpromise.Promise<WebElement[]> => {
return this.getWebElements().then((parentWebElements: WebElement[]) => {
Expand Down Expand Up @@ -277,7 +277,7 @@ export class ElementArrayFinder extends WebdriverWebElement {
* @param {number|webdriver.promise.Promise} index Element index.
* @returns {ElementFinder} finder representing element at the given index.
*/
get(index: number|wdpromise.Promise<number>): ElementFinder {
get(index: number | wdpromise.Promise<number>): ElementFinder {
let getWebElements = (): wdpromise.Promise<WebElement[]> => {
return wdpromise.all<any>([index, this.getWebElements()]).then(([i, parentWebElements]) => {
if (i < 0) {
Expand Down Expand Up @@ -553,7 +553,7 @@ export class ElementArrayFinder extends WebdriverWebElement {
* an array of ElementFinders represented by the ElementArrayFinder.
*/
then<T>(
fn?: (value: ElementFinder[]|any[]) => T | wdpromise.IThenable<T>,
fn?: (value: ElementFinder[] | any[]) => T | wdpromise.IThenable<T>,
errorFn?: (error: any) => any): wdpromise.Promise<T> {
if (this.actionResults_) {
return this.actionResults_.then(fn, errorFn);
Expand Down Expand Up @@ -597,8 +597,8 @@ export class ElementArrayFinder extends WebdriverWebElement {
* function has been called on all the ElementFinders. The promise will
* resolve to null.
*/
each(fn: (elementFinder?: ElementFinder, index?: number) => any): wdpromise.Promise<any> {
return this.map(fn).then((): any => {
each(fn: (elementFinder: ElementFinder, index: number) => any): wdpromise.Promise<any> {
return this.map(fn).then((): null => {
return null;
});
}
Expand Down Expand Up @@ -650,10 +650,10 @@ export class ElementArrayFinder extends WebdriverWebElement {
* @returns {!webdriver.promise.Promise} A promise that resolves to an array
* of values returned by the map function.
*/
map<T>(mapFn: (elementFinder?: ElementFinder, index?: number) => T | any):
map<T>(mapFn: (elementFinder: ElementFinder, index: number) => T | any):
wdpromise.Promise<T[]> {
return this.asElementFinders_().then<T[]>((arr: ElementFinder[]) => {
let list = arr.map((elementFinder?: ElementFinder, index?: number) => {
let list = arr.map((elementFinder: ElementFinder, index: number) => {
let mapResult = mapFn(elementFinder, index);
// All nested arrays and objects will also be fully resolved.
return wdpromise.fullyResolved(mapResult) as wdpromise.Promise<T>;
Expand Down Expand Up @@ -704,7 +704,9 @@ export class ElementArrayFinder extends WebdriverWebElement {
* @returns {!webdriver.promise.Promise} A promise that resolves to the final
* value of the accumulator.
*/
reduce(reduceFn: Function, initialValue: any): wdpromise.Promise<any> {
reduce(
reduceFn: (accumulator: any, current: ElementFinder, index: number, arr: ElementFinder[]) => any,
initialValue: any): wdpromise.Promise<any> {
let valuePromise = wdpromise.when(initialValue);
return this.asElementFinders_().then((arr: ElementFinder[]) => {
return arr.reduce((valuePromise: any, elementFinder: ElementFinder, index: number) => {
Expand Down