Skip to content
Snippets Groups Projects
README.md 928 B
Newer Older
  • Learn to ignore specific revisions
  • Jason Mulligan's avatar
    Jason Mulligan committed
    # tiny-worker
    
    Tiny WebWorker for Server
    
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    This is non-functional, it's just a place holder for 1.0.0!
    
    
    [![build status](https://secure.travis-ci.org/avoidwork/tiny-worker.svg)](http://travis-ci.org/avoidwork/tiny-worker)
    
    ## Example
    ```javascript
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    var Worker = require("tiny-worker");
    var worker = new Worker(function () {
    	self.onmessage = function (ev) {
    		postMessage(ev.data);
    	};
    
    });
    
    worker.onmessage = function (ev) {
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    	console.log(ev.data);
    	worker.terminate();
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    worker.postMessage("Hello World!");
    
    ```
    
    ## Properties
    #### onmessage
    Message handler, accepts an `Event`
    
    #### onerror
    Error handler, accepts an `Event`
    
    ## API
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    #### addEventListener(event, fn)
    Adds an event listener
    
    #### close()
    Terminates the `Worker`, same as `terminate()`
    
    
    #### postMessage()
    Broadcasts a message to the `Worker`
    
    
    Jason Mulligan's avatar
    Jason Mulligan committed
    #### terminate()
    Terminates the `Worker`
    
    
    ## License
    Copyright (c) 2015 Jason Mulligan
    Licensed under the BSD-3 license