Giter Club home page Giter Club logo

processor's Introduction

Travis CI

Description

Tiny library to execute code on multi threads. Result of each thread is resturned as a promise. Processor can use any promise library (see Promise chapter).

Installation

  • Download the latest release.
  • Clone the repo: git clone https://github.com/jccazeaux/processor.git.
  • Install with npm: npm install promised-processor.

Quick start

Create a new thread

var t = processor.thread(function(a, b) {
	return a + b;
});

Execute thread

thread function returns an object containing a function exec. This function will execute the thread. All exec arguments will be sent to thread function.

t.exec(1, 2);

Get result

exec function returns result of thread function as a promise.

t.exec(1, 2)
.then(function(res) {
	console.log(res); // 3
});

Handle errors

Errors are handled by promise

processor.thread(function() {
	throw new Error("I failed");
})
.exec()
.catch(function(message) {
	console.log(message); // I failed
});

Configuration

Number of concurrent threads

By default processor will have a pool of two threads. You can configure this number with config.nbThreads function

processor.config.nbThreads(4);

Keep in mind it may be useless to configure more threads than the number of cores.

Promises

processor can adapt to these promises library

You may define use any promise library. You just need to define an adapter. This adapter creates a function that creates the promises and takes resolve and rejects as parameters.

As an exemple, here is default adapter

function() {
	var res;
	if (window.Promise) {
		res = function(resolve, reject) {
			return new window.Promise(resolve, reject);
		};
	} else if (window.Q) {
		res = function(resolve, reject) {
			return Q.Promise(resolve, reject);
		};
	} else {
		throw "No recognized promise library nor ES6 Promise. Try to customize with processor.promiseAdapter";
	}
	return res;
}

To define a new one

processor.config.promiseAdapter(function() {
	return function(resolve, reject) {
		// Code your adapter here
	};
});

processor's People

Contributors

jccazeaux avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.