Namespace atropa.waitFor

Version 20120909.
Polling functions for quick and sloppy work.
Defined in: <node_modules/atropa-waitFor/src/atropa-waitFor.js>.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	atropa.waitFor Polling functions for quick and sloppy work.

Method Summary
Method Attributes	Method Name and Description
<static>	atropa.waitFor.element(testFn) Wait for Element
<static>	atropa.waitFor.test(testFn, onSuccessCallback, onMaxPollCallback, pollInterval, maxPoll) Generic Wait for true.

Namespace Detail

atropa.waitFor

Polling functions for quick and sloppy work.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Method Detail

<static> atropa.waitFor.element(testFn)

Wait for Element
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

See:: atropa.waitFor.test for more information and default values for the optional parameters.

<static> atropa.waitFor.test(testFn, onSuccessCallback, onMaxPollCallback, pollInterval, maxPoll)

Generic Wait for true.
Author: Matthew Christopher Kastor-Inare III
☭ Hial Atropa!! ☭.

Parameters:
{Function} testFn: A function to tell when the wait is over. Must return true on success, false on failure.
{Function} onSuccessCallback: Optional. The function to run when testFn returns true. Defaults to function () {}
{function} onMaxPollCallback: Optional. The function to run when testFn has been run maxPoll times and the wait is being given up. Defaults to function () {}
{Integer} pollInterval: Optional. The amount of time in ms between polling testFn to see if it returns true. Defaults to 200ms.
{Integer} maxPoll: Optional. The quantity of polls at which it makes sense to give up waiting. Defaults to 50.

Classes