API Docs for: 0.9.14
Show:

MonkeyBars Class

Methods

createBlobWithTask

(
  • task
)
Blob private

Defined in ../temp/monkeybars.js:283

Creates a blob string to be used with the web worker for concurrent task execution

Parameters:

Returns:

Blob: Blob instance

createPropertyDescriptorsWithAttributes

(
  • attributes
)
Object private

Defined in ../temp/monkeybars.js:174

Creates property descriptors from the passes attributes.

Parameters:

  • attributes Object

Returns:

Object: Property descriptors object

createSubTasksFromTaskOptionsArray

(
  • tasks
)
Array private

Defined in ../temp/monkeybars.js:156

Creates an array of tasks based on the options array passed.

Parameters:

  • tasks Array

Returns:

Array: Array of tasks

createTaskWithOptions

(
  • options
)
Task private

Defined in ../temp/monkeybars.js:96

Creates task based on the options passed.

Parameters:

  • options Object

Returns:

Task: Task

createWebWorkerWithBlobAndTask

(
  • blob
  • task
)
Worker private

Defined in ../temp/monkeybars.js:317

Creates a web Worker instance with the passed arguments

Parameters:

  • blob Blob
  • task Task

Returns:

Worker: WebWorker instance

decorateTaskBasedOnAttributes

(
  • task
  • attributes
)
private

Defined in ../temp/monkeybars.js:385

Parameters:

  • task Task
  • attributes Object

extend

(
  • protoProps
)
Function private

Defined in ../temp/monkeybars.js:404

Extention functionality for various task types.

Parameters:

  • protoProps Object

Returns:

Function: child Constructor function for extended task type

Example:

var CustomTask = MonkeyBars.Task.extend({
    name:"CustomTask",
    newMethod:function(){
        console.log("Executing newMethod");
    }
});
var instance = new CustomTask();

forTaskDecorator

(
  • task
)
private

Defined in ../temp/monkeybars.js:1893

Decorator to provide for loop functionality for the task. The task executes as many times as referenced by the count attribute provided by the instance.

Parameters:

  • task Object

generateUniqueId

(
  • prefix
)
String private

Defined in ../temp/monkeybars.js:193

Generates a unique id for each task.

Parameters:

  • prefix String

Returns:

String: tid

isTaskDependentOnTask

(
  • task1
  • task2
)
Boolean private

Defined in ../temp/monkeybars.js:207

Determains whether the first task is dependent on the second.

Parameters:

Returns:

Boolean: Whether or not the task is dependent on the other

log

(
  • msg
)
private

Defined in ../temp/monkeybars.js:430

Simple console.log wrapper

Parameters:

  • msg Object

performTaskFunctionalityWithWebWorker

(
  • task
)
private

Defined in ../temp/monkeybars.js:363

Performs the tasks performTask functionality within a web worker

Parameters:

serialize

(
  • o
)
String private

Defined in ../temp/monkeybars.js:232

Variation of http://blog.stchur.com/2007/04/06/serializing-objects-in-javascript/

Parameters:

  • o Object

Returns:

String: Serialized string representation of the passed object

whenTaskDecorator

(
  • task
)
private

Defined in ../temp/monkeybars.js:1946

The task doesnt execute until the when method provided returns true.

Parameters:

  • task Object

whileTaskDecorator

(
  • task
)
private

Defined in ../temp/monkeybars.js:1917

Decorator to provide while loop functionaliy. The task executed until the while method returns false.

Parameters:

  • task Object

Properties

LogLevels

Object final

Defined in ../temp/monkeybars.js:1998

Log level contstants.

MonkeyBars

Object

Defined in ../temp/monkeybars.js:75

Object returned by module. Works as namespace for the task library.

root

Object private

Defined in ../temp/monkeybars.js:43

Reference to the global js object (i.e. brower's window)

taskIdCounter

Integer private

Defined in ../temp/monkeybars.js:52

Counter used to create unique task ids

taskOptions

Array private

Defined in ../temp/monkeybars.js:61

List of all whitelisted properties for a task

TaskStates

Object final

Defined in ../temp/monkeybars.js:1970

Task states contstants.

TaskTypes

Object final

Defined in ../temp/monkeybars.js:1985

Task types contstants.