webdemo
Web-based mouse and keyboard automation tool.
1. Installation
1. Download the WebDemo module:
~$ npm install --save webdemo
2. Include all the dependencies in your HTML:
2. Usage
1. Create a new webdemo instance:
const demo = "Name of this demo";
2. Add tasks to the demo:
demo;demo;demotype"Developer";demo;demotype"This is a secret";demo;demotype"None of your business";demo;demo;
3. Run the demo:
demostart { // once finished all the tasks...};
And the demo will start.
3. API Reference
WebDemo
Type: {Class}
Parameter: {String} title
Title of the new demo.
Returns: {WebDemo}
A new instance of WebDemo class.
Description: This class generates a new WebDemo. With this objects, we can automate browser tasks.
webDemo._
Type: {Object}
Description: Object that holds the internal stuff of the WebDemo instance.
webDemo._.title
Type: {String} title
Description: Name of the current webDemo.
webDemo._.subject
Type: {HTMLElement}
Description: Element that has the current focus of the webDemo. This means that the actions registered will have this element as target.
webDemo._.logger
Type: {Object:DOMLogger}
Url: https://www.npmjs.com/package/domlogger
Url: https://github.com/allnulled/domlogger
Description: This object can log messages that one can see in the same page (without the need of opening the console).
webDemo._.tasks
Type: {Array}
Description: Holds all the tasks that have been registered for this webDemo.
webDemo._.cursor
Type: {HTMLElement}
Description: Image of a cursor, that will move over the screen, simulating the click and drag'n'drop events.
webDemo.start()
Type: {Function}
Parameter: {Function} onFinish
Optional. Callback for when the demo is over.
Returns: {WebDemo}
Description: Starts the demo.
webDemo.inform(message, mode="log")
Type: {Function}
Parameter: {String} message
Message to be shown.
Parameter: {String} mode
Method to be used for the logging (relative to DOMLogger).
Returns: {WebDemo}
Description: Logs a message by the DOMLogger instance.
webDemo.mouse(elementReference)
Type: {Function}
Parameter: {HTMLElement} elementReference
Element in which to put the mouse over.
Returns: {WebDemo}
Returns the same webDemo instance.
Description: Moves the mouse to put it over the center of an {HTMLElement}
.
WebDemo.click()
Type: {Function}
Parameter: {String} text
Text to type.
Parameter: {Number} speedOpt
Useless for now.
Returns: {WebDemo}
Returns the same webDemo instance.
WebDemo.type(test, speedOption)
Type: {Function}
Parameter: {String} text
Text to type.
Parameter: {Number} speedOpt
Useless for now.
Returns: {WebDemo}
Returns the same webDemo instance.
webDemo.then(asyncFn)
Type: {Function}
Parameter: {AsyncFunction}
Asynchronous function (it
means that its first parameter is the call to the next
asynchronous operation) that gets executed when the running
thread dispatches it, and that is finished when the first
parameter that this function receives, is called.
Returns: {webDemo}
Returns the same webDemo instance.
Description: Registers a new task which executes the asynchronous function that is passed as first parameter.
4. Conclusion
Simple library to simulate user's behaviour on a webpage.