promise_context v0.1.1

PromiseContext

PromiseContext gives a useful asynchronous executing context.

• easy chaining of executors
• optional completion routine
• deferred subroutine call
• subroutine can be looped
• break/continue a loop
• labelled break/continue

Basic

Let A be an example executor below.

function A(resolve, reject){
	console.log("in A")
	setTimeout(function(){
		resolve()
		console.log("out A")
	}
	, 100) // 100ms
}

Let B and C are executors similar to A.

In order to execute these executors in a row, do the following:

const PromiseContext = require("promise_context")
var ctx = new PromiseContext()
ctx.chain(A)
ctx.chain(B)
ctx.chain(C)
ctx.end()

A is called asynchronously after ctx.end(). B is called after A is resolved. C is called after B is resolved.

As a result of this example, following sequence will be printed on console:

in A
out A
in B
out B
in C
out C

Following code is equivalent to the above code.

new PromiseContext().chain(A).chain(B).chain(C).end()

Catching an error or a rejection

Same manner as Promise.

ctx.chain(A)
ctx.catch(function(err){
	// if A called 'reject(err)' instead of 'resolve()', 
	// 'err' would hold the value rejected in A.
})

Completion

Completion routines can be set as follows:

ctx.setCompletion(onFulfilled, onRejected)

One of completion routines will be called after all the executors resolved.

Subroutine

var ctx = new PromiseContext()
ctx.chain(A)
ctx.call(function sub(){
	ctx.chain(B)
	ctx.chain(C)
})
ctx.chain(D)
ctx.end()

This example obtains the same result as ctx.chain(A).chain(B).chain(C).chain(D) although the function 'sub' is executed asynchronously after A is resolved.

Loop

var i=0
ctx.loop(function (){
	ctx.chain(A)
	ctx.chain(B)
	if (++i == 3) ctx.break()
})

This example obtains the same result as ctx.chain(A).chain(B).chain(A).chain(B).chain(A).chain(B) although each iteration is executed asynchronously after the previous iteration is resolved.

Break a labelled loop

ctx.loop('L1', function (){
	ctx.chain(A)
	var i=0
	ctx.loop(function (){
		ctx.chain(B)
		ctx.catch(function (err){
			ctx.break('L1') // break outer loop
		})
		if (++i == 5) ctx.break() // break inner loop
	})
})

Continue a loop

ctx.loop(function (){
	ctx.chain(A)
	ctx.catch(function (err){
		ctx.chain(B)
		ctx.continue()
	})
	ctx.chain(C)
})