Interface Browser

public any(clsConstructor: Function): any

Parameters

• clsConstructor: Function

Returns

any

public beginAsync(time: number, errback: Function): any

Parameters

• time: number

• errback: Function

Returns

any

public chain(steps: IAction[])

Parameters

• steps: IAction[]

public chain(step?: IAction[])

Parameters

• step?: IAction[] optional

public chainClick(elements: Array<any>, callback: Function)

Parameters

• elements: Array<any>

• callback: Function

public click(el?: any, callback?: Function, scope?: any, options?: any)

Parameters

• el?: any optional

• callback?: Function optional

• scope?: any optional

• options?: any optional

public click(callback?: Function, scope?: any, options?: any)

Parameters

• callback?: Function optional

• scope?: any optional

• options?: any optional

public clickSelector(selector: string, callback: Function, scope?: any)

Parameters

• selector: string

• callback: Function

• scope?: any optional

public clickSelector(selector: string, root: any, callback: Function, scope?: any)

Parameters

• selector: string

• root: any

• callback: Function

• scope?: any optional

public compareObjects(obj1: any, obj2: any, strict?: boolean, onlyPrimitives?: boolean, asObjects?: boolean): boolean

Parameters

• obj1: any

• obj2: any

• strict?: boolean optional

• onlyPrimitives?: boolean optional

• asObjects?: boolean optional

Returns

boolean

public contentLike(el: any, text: string, description?: string)

Parameters

• el: any

• text: string

• description?: string optional

public contentNotLike(el: any, text: string, description?: string)

Parameters

• el: any

• text: string

• description?: string optional

public ddescribe(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional

public describe(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional

public diag(desc: string)

Parameters

• desc: string

public done(delay: number)

Parameters

• delay: number

public doubleClick(el?: any, callback?: Function, scope?: any, options?: any)

Parameters

• el?: any optional

• callback?: Function optional

• scope?: any optional

• options?: any optional

public doubleClick(callback?: Function, scope?: any, options?: any)

Parameters

• callback?: Function optional

• scope?: any optional

• options?: any optional

public drag(source: any, target?: any, delta?: Array<number>, callback?: Function, scope?: any, options?: any)

Parameters

• source: any

• target?: any optional

• delta?: Array<number> optional

• callback?: Function optional

• scope?: any optional

• options?: any optional

public dragBy(source: any, delta: Array<number>, callback?: Function, scope?: any, options?: any, dragOnly?: boolean)

Parameters

• source: any

• delta: Array<number>

• callback?: Function optional

• scope?: any optional

• options?: any optional

• dragOnly?: boolean optional

public dragTo(source: any, target: any, callback?: Function, scope?: any, options?: any, dragOnly?: boolean)

Parameters

• source: any

• target: any

• callback?: Function optional

• scope?: any optional

• options?: any optional

• dragOnly?: boolean optional

public elementIsAt(el: any, xy: Array<number>, allowChildren: boolean, description?: string)

Parameters

• el: any

• xy: Array<number>

• allowChildren: boolean

• description?: string optional

public elementIsInView(el: any)

Parameters

• el: any

public elementIsNotTopElement(el: any, allowChildren: boolean, description?: string)

Parameters

• el: any

• allowChildren: boolean

• description?: string optional

public elementIsNotVisible(el: any, description?: string)

Parameters

• el: any

• description?: string optional

public elementIsTop(el: any, allowChildren: boolean): boolean

Parameters

• el: any

• allowChildren: boolean

Returns

boolean

public elementIsTopElement(el: any, allowChildren: boolean, description?: string, strict?: any)

Parameters

• el: any

• allowChildren: boolean

• description?: string optional

• strict?: any optional

public elementIsVisible(el: any, description?: string)

Parameters

• el: any

• description?: string optional

public endAsync(frame: any)

Parameters

• frame: any

public endWait(title: string)

Parameters

• title: string

public expect(value: any): Expectation

Parameters

• value: any

Returns

Expectation

public expectGlobals(names?: Array<any>)

Parameters

• names?: Array<any> optional

public fail(desc: string, annotation: any)

Parameters

• desc: string

• annotation: any

public findCenter(el: any, local?: boolean): Array<number>

Parameters

• el: any

• local?: boolean optional

Returns

Array<number>

public getSelectedText(el: any): string

Parameters

• el: any

Returns

string

public getSubTest(name: string, code: (t: Siesta.ITest) => void, timeout?: number): ITest

Parameters

• name: string

• code: (t: Siesta.ITest) => void

• timeout?: number optional

Returns

ITest

public hasCls(el: any, cls: string, description?: string)

Parameters

• el: any

• cls: string

• description?: string optional

public hasNotCls(el: any, cls: string, description?: string)

Parameters

• el: any

• cls: string

• description?: string optional

public hasNotStyle(el: any, property: string, value: string, description?: string)

Parameters

• el: any

• property: string

• value: string

• description?: string optional

public hasStyle(el: any, property: string, value: string, description?: string)

Parameters

• el: any

• property: string

• value: string

• description?: string optional

public iit(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional

public is(got: any, expected: any, desc: string)

Parameters

• got: any

• expected: any

• desc: string

public isApprox(value1: number, value2: number, threshHold: number, desc: string)

Parameters

• value1: number

• value2: number

• threshHold: number

• desc: string

public isArray(value: any, desc: string)

Parameters

• value: any

• desc: string

public isBoolean(value: any, desc: string)

Parameters

• value: any

• desc: string

public isCalled(fn: string, host: any, desc: string)

Parameters

• fn: string

• host: any

• desc: string

public isCalled(fn: Function, host: any, desc: string)

Parameters

• fn: Function

• host: any

• desc: string

public isCalledNTimes(fn: string, host: any, n: number, desc: string)

Parameters

• fn: string

• host: any

• n: number

• desc: string

public isCalledNTimes(fn: Function, host: any, n: number, desc: string)

Parameters

• fn: Function

• host: any

• n: number

• desc: string

public isCalledOnce(fn: string, host: any, desc: string)

Parameters

• fn: string

• host: any

• desc: string

public isCalledOnce(fn: Function, host: any, desc: string)

Parameters

• fn: Function

• host: any

• desc: string

public isDate(value: any, desc: string)

Parameters

• value: any

• desc: string

public isDateEqual(got: Date, expectedDate: Date, description?: string)

Parameters

• got: Date

• expectedDate: Date

• description?: string optional

public isDeeply(obj1: any, obj2: any, desc: string)

Parameters

• obj1: any

• obj2: any

• desc: string

public isDeeplyStrict(obj1: any, obj2: any, desc: string)

Parameters

• obj1: any

• obj2: any

• desc: string

public isElementVisible(el: any): boolean

Parameters

• el: any

Returns

boolean

public isFunction(value: any, desc: string)

Parameters

• value: any

• desc: string

public isGreater(value1: any, value2: any, desc: string)

Parameters

• value1: any

• value2: any

• desc: string

public isGreaterOrEqual(value1: any, value2: any, desc: string)

Parameters

• value1: any

• value2: any

• desc: string

public isInView(el: any, description?: string)

Parameters

• el: any

• description?: string optional

public isLess(value1: any, value2: any, desc: string)

Parameters

• value1: any

• value2: any

• desc: string

public isLessOrEqual(value1: any, value2: any, desc: string)

Parameters

• value1: any

• value2: any

• desc: string

public isNot(got: any, expected: any, desc: string)

Parameters

• got: any

• expected: any

• desc: string

public isNotStrict(got: any, expected: any, desc: string)

Parameters

• got: any

• expected: any

• desc: string

public isNumber(value: any, desc: string)

Parameters

• value: any

• desc: string

public isObject(value: any, desc: string)

Parameters

• value: any

• desc: string

public isReady(): any

Returns

any

public isRegExp(value: any, desc: string)

Parameters

• value: any

• desc: string

public isStrict(got: any, expected: any, desc: string)

Parameters

• got: any

• expected: any

• desc: string

public isString(value: any, desc: string)

Parameters

• value: any

• desc: string

public isaOk(value: any, className: string, desc: string)

Parameters

• value: any

• className: string

• desc: string

public isaOk(value: any, className: Function, desc: string)

Parameters

• value: any

• className: Function

• desc: string

public isntCalled(fn: string, host: any, n: number, desc: string)

Parameters

• fn: string

• host: any

• n: number

• desc: string

public isntCalled(fn: Function, host: any, n: number, desc: string)

Parameters

• fn: Function

• host: any

• n: number

• desc: string

public it(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional

public keyPress(el: any, key: string, options: any)

Parameters

• el: any

• key: string

• options: any

public launchSubTest(subTest: ITest, callback: Function)

Parameters

• subTest: ITest

• callback: Function

public like(string: string, regex: string, desc: string)

Parameters

• string: string

• regex: string

• desc: string

public like(string: string, regex: RegExp, desc: string)

Parameters

• string: string

• regex: RegExp

• desc: string

public livesOk(func: Function, desc: string)

Parameters

• func: Function

• desc: string

public methodIsCalled(fn: string, className: string, desc: string)

Parameters

• fn: string

• className: string

• desc: string

public methodIsCalled(fn: Function, className: string, desc: string)

Parameters

• fn: Function

• className: string

• desc: string

public methodIsCalled(fn: string, className: Function, desc: string)

Parameters

• fn: string

• className: Function

• desc: string

public methodIsCalled(fn: Function, className: Function, desc: string)

Parameters

• fn: Function

• className: Function

• desc: string

public methodIsCalledNTimes(fn: string, className: string, n: number, desc: string)

Parameters

• fn: string

• className: string

• n: number

• desc: string

public methodIsCalledNTimes(fn: Function, className: string, n: number, desc: string)

Parameters

• fn: Function

• className: string

• n: number

• desc: string

public methodIsCalledNTimes(fn: string, className: Function, n: number, desc: string)

Parameters

• fn: string

• className: Function

• n: number

• desc: string

public methodIsCalledNTimes(fn: Function, className: Function, n: number, desc: string)

Parameters

• fn: Function

• className: Function

• n: number

• desc: string

public methodIsntCalled(fn: string, className: string, desc: string)

Parameters

• fn: string

• className: string

• desc: string

public methodIsntCalled(fn: Function, className: string, desc: string)

Parameters

• fn: Function

• className: string

• desc: string

public methodIsntCalled(fn: string, className: Function, desc: string)

Parameters

• fn: string

• className: Function

• desc: string

public methodIsntCalled(fn: Function, className: Function, desc: string)

Parameters

• fn: Function

• className: Function

• desc: string

public monkeyTest(el: any, nbrInteractions: number, description?: string, callback?: Function, scope?: any)

Parameters

• el: any

• nbrInteractions: number

• description?: string optional

• callback?: Function optional

• scope?: any optional

public mouseDown(el: any, options: any)

Parameters

• el: any

• options: any

public mouseOut(el: any, options: any)

Parameters

• el: any

• options: any

public mouseOver(el: any, options: any)

Parameters

• el: any

• options: any

public mouseUp(el: any, options: any)

Parameters

• el: any

• options: any

public moveCursorBy(delta: Array<number>, callback?: Function, scope?: any)

Parameters

• delta: Array<number>

• callback?: Function optional

• scope?: any optional

public moveCursorTo(target?: any, callback?: Function, scope?: any)

Parameters

• target?: any optional

• callback?: Function optional

• scope?: any optional

public moveMouseBy(delta: Array<number>, callback?: Function, scope?: any)

Parameters

• delta: Array<number>

• callback?: Function optional

• scope?: any optional

public moveMouseTo(target?: any, callback?: Function, scope?: any)

Parameters

• target?: any optional

• callback?: Function optional

• scope?: any optional

public notOk(value: any, desc: string)

Parameters

• value: any

• desc: string

public ok(value: any, desc: string)

Parameters

• value: any

• desc: string

public pass(desc: string, annotation: any)

Parameters

• desc: string

• annotation: any

public rightClick(el?: any, callback?: Function, scope?: any, options?: any)

Parameters

• el?: any optional

• callback?: Function optional

• scope?: any optional

• options?: any optional

public rightClick(callback?: Function, scope?: any, options?: any)

Parameters

• callback?: Function optional

• scope?: any optional

• options?: any optional

public scrollHorizontallyTo(el: any, newLeft: number, delay?: number, callback?: Function): number

Parameters

• el: any

• newLeft: number

• delay?: number optional

• callback?: Function optional

Returns

number

public scrollVerticallyTo(el: any, newTop: number, delay?: number, callback?: Function): number

Parameters

• el: any

• newTop: number

• delay?: number optional

• callback?: Function optional

Returns

number

public selectText(el: any, start?: number, end?: number)

Parameters

• el: any

• start?: number optional

• end?: number optional

public selectorCountIs(selector: string, count: number, description: string)

Parameters

• selector: string

• count: number

• description: string

public selectorCountIs(selector: string, root: any, count: number, description: string)

Parameters

• selector: string

• root: any

• count: number

• description: string

public selectorExists(selector: string, description?: string)

Parameters

• selector: string

• description?: string optional

public selectorIsAt(selector: string, xy: Array<number>, allowChildren: boolean, description?: string)

Parameters

• selector: string

• xy: Array<number>

• allowChildren: boolean

• description?: string optional

public selectorNotExists(selector: string, description?: string)

Parameters

• selector: string

• description?: string optional

public simulateEvent(el: any, type: string, the?: any, suppressLog?: boolean)

Parameters

• el: any

• type: string

• the?: any optional

• suppressLog?: boolean optional

public subTest(desc: string, code: (t: Siesta.ITest) => void, callback: Function, timeout?: number)

Parameters

• desc: string

• code: (t: Siesta.ITest) => void

• callback: Function

• timeout?: number optional

public throwsOk(func: Function, expected: string, desc: string)

Parameters

• func: Function

• expected: string

• desc: string

public throwsOk(func: Function, expected: RegExp, desc: string)

Parameters

• func: Function

• expected: RegExp

• desc: string

public todo(why: string, code: Function)

Parameters

• why: string

• code: Function

public type(el: any, text: string, callback?: Function, scope?: any, options?: any)

Parameters

• el: any

• text: string

• callback?: Function optional

• scope?: any optional

• options?: any optional

public typeOf(object: any): string

Parameters

• object: any

Returns

string

public unlike(string: string, regex: string, desc: string)

Parameters

• string: string

• regex: string

• desc: string

public unlike(string: string, regex: RegExp, desc: string)

Parameters

• string: string

• regex: RegExp

• desc: string

public verifyGlobals(names?: Array<string>)

Parameters

• names?: Array<string> optional

public wait(title: string, howLong: number)

Parameters

• title: string

• howLong: number

public waitFor(wait: number, callback: Function, scope?: any, timeout?: number, interval?: number): IWaitForReturn

Parameters

• wait: number

• callback: Function

• scope?: any optional

• timeout?: number optional

• interval?: number optional

Returns

IWaitForReturn

public waitFor(method: Function, callback: Function, scope?: any, timeout?: number, interval?: number): IWaitForReturn

Parameters

• method: Function

• callback: Function

• scope?: any optional

• timeout?: number optional

• interval?: number optional

Returns

IWaitForReturn

public waitFor(config: IWaitForConfig): IWaitForReturn

Parameters

• config: IWaitForConfig

Returns

IWaitForReturn

public waitForContentLike(el: any, text: string, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• text: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForContentNotLike(el: any, text: string, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• text: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForElementNotTop(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForElementNotVisible(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForElementTop(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForElementVisible(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForScrollChange(el: any, side: string, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• side: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForScrollLeftChange(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForScrollTopChange(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelector(selector: string, callback: Function, scope?: any, timeout?: number)

Parameters

• selector: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelector(selector: string, root: any, callback: Function, scope?: any, timeout?: number)

Parameters

• selector: string

• root: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectorAt(xy: Array<number>, selector: string, callback: Function, scope?: any, timeout?: number)

Parameters

• xy: Array<number>

• selector: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectorAtCursor(xy: Array<number>, selector: string, callback: Function, scope?: any, timeout?: number)

Parameters

• xy: Array<number>

• selector: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectorNotFound(selector: string, callback: Function, scope?: any, timeout?: number)

Parameters

• selector: string

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectorNotFound(selector: string, root: any, callback: Function, scope?: any, timeout?: number)

Parameters

• selector: string

• root: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectors(selectors: Array<string>, callback: Function, scope?: any, timeout?: number)

Parameters

• selectors: Array<string>

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitForSelectors(selectors: Array<string>, root: any, callback: Function, scope?: any, timeout?: number)

Parameters

• selectors: Array<string>

• root: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public waitUntilInView(el: any, callback: Function, scope?: any, timeout?: number)

Parameters

• el: any

• callback: Function

• scope?: any optional

• timeout?: number optional

public xdescribe(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional

public xit(name: string, code: Function, timeout?: number)

Parameters

• name: string

• code: Function

• timeout?: number optional