1.0.5 • Published 9 years ago

ordenado v1.0.5

Weekly downloads
4
License
ISC
Repository
github
Last release
9 years ago

ordenado

Build Status Code Climate Test Coverage Dependency Status devDependency Status bitHound Score

ducks-in-a-row

ordenado is a synchronous (ordered) task runner for Node.js and Browser
... for when you need to have "all your ducks in a row".

Why?

JavaScript is synchronous and single-threaded, but when multiple statements are called in succession,
results can be returned in an unexpected order ... Often we need to run a sequence of tasks in a specific order.

We wrote this for alvo our automated browser test runner. But its useable anywhere that runs JavaScript!

What?

Lets you run a series of JavaScript functions/methods in a specific order and then execute a callback (once) at the end.

Tested in node.js Build Status Node version npm version

and ALL teh Devices/Browsers via SauceLabs Sauce Test Status

Try it yourself: https://ordenado.herokuapp.com/

How?

install from npm

npm install ordenado --save-dev

Usage

Node.js

var ordenado = require('ordenado'); // load the module

ordenado([
  function(callback){
    // perform the first task
    callback(null, 'one');
  },
  function(arg1, arg2, callback){
    // perform second task
    callback(null, 'two');
  },
  function(callback){
    // perform third task, etc.
    callback(null, 'done');
  }
], function callback(err, result) {
  // result now equals 'done'
  // callback only gets called once!
});

Browser

Tip: don't try to load the script directly from GitHub (they don't like that...) instead use https://raw.githubusercontent.com/dwyl/ordenado/master/index.js

in your html:

<script src="https://raw.githubusercontent.com/dwyl/ordenado/master/index.js"> </script>

<script>
  ordenado([
    function(callback){
      // perform the first task
      callback(null, 'one');
    },
    function(arg1, arg2, callback){
      // perform second task
      callback(null, 'two');
    },
    function(callback){
      // perform third task, etc.
      callback(null, 'done');
    }
  ], function callback(err, result) {
    // result now equals 'done'
    // callback only gets called once!
  });
</script>

see: example/index.html for copy-pasteable example code.

tl;dr

Background Reading

Name?

All the "good" names are taken.
So we used the Portuguese/Spanish word for "orderly" see: https://translate.google.com/#auto/en/ordenado