Easy Communication Protocol For Web Workers
CoffeeScript HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
.gitignore
CNAME Create CNAME Nov 7, 2014
LICENSE.md First release. Apr 1, 2013
README.md
easy-web-worker.coffee Issue #2 should been fixed. Sep 30, 2013
easy-web-worker.js
easy-web-worker.map Issue #2 should been fixed. Sep 30, 2013

README.md

This library is not in development anymore because of great alternatives, use one of them; parallel.js, operative, catiline.

Easywebworker v0.2.1
Easy Communication Protocol For Web Workers
Just execute worker functions from browser, and main functions from worker.

Also work when web worker is not available. So support Web Worker on older Internet Explorers.

Features

  • Fallback support for old browsers. (AKA Internet Explorer Support.)
  • Execute functions directly. Nested functions are supported.
  • Execute global functions from worker.
  • Start Worker with startup data.
  • Alias for console.log for ease debugging.

Changelog

  • 0.2.1 - XDomainRequest Fallback Support added for crossdomain request on older internet explorers.

Prepare

On Browser

// Just include script to page and create EasyWebWorker with context.
var worker = new EasyWebWorker("worker.js", this);

In Worker

// Just import script.
importScripts("easy-web-worker.js");

Methods

Error Statement (On browser.):

worker.onerror = function(event,filename,lineno,message){
    // ...
}

Terminate From Browser:

worker.terminate();
// or
worker.close();

Terminate In Worker (Same as default.):

self.close();

Examples

Example 1 (Simple Usage)

Browser:

// Execute function
worker.execute("getSquares", [2,3,5]);

// And our callback function.
function getSquaresCallback(event, squares) {
    console.log("Here is our squares: ",squares)
}

Worker:

function getSquares(event, numberArray){
    // Do stuff.
    squares = [];
    for(var i=0, len=numberArray.length; i<len; i++){
        number = numberArray[i];
        squares.push(number*number);
    }

    // Call our callback function.
    self.execute("getSquaresCallback", squares);
}

Example 2 (Nested Functions)

Browser:

// Execute function.
worker.execute("textOperations.reverseText", "Hello guys wazzup?")

// Our nested callback function.
var NestedFunctions = {
  textPrinter: {
      printToConsole: function(event, textToPrint) {
          console.log("Here is our reversed text: ", textToPrint, this)

          // Context test.
          this.printToTitle(textToPrint)
      },
      printToTitle: function(text) {
          window.document.title = text
      }
  }
}

Worker:

// Our nested function.
textOperations = {
  reverseText: function(event, text) {
    var reversedText = text.split("").reverse().join("");
    return self.execute("NestedFunctions.textPrinter.printToConsole", reversedText);
  }
};

Example 3 (Startup Data)

(It uses worker file's querystring. So keep it as tiny as possible.) Browser:

// Create startup data.
var startupData = {name:"Derp", surname:"Derpson", age:"23"}

// Create worker with startupData.
var workerTwo = new EasyWebWorker('demo-worker.js', this, startupData)

// Execute worker.
workerTwo.execute("whatIsTheSettings")

// Get our startupData back.
getSettingsBack = function(event, startupData){
    console.log("Here is our startup data: ", startupData)
}

Worker:

function whatIsTheSettings(){
    // Give settings back.
    self.execute("getSettingsBack", self.startupData)
}

Example 4 (Call Global Function)

Worker:

self.execute("window.console.log", "Hello world!")

// There is an alias for console log.
self.log("Hello World!")