Build Status

A framework for creating and running data pipelines. Data pipelines have stages, which are made of an arbitrary number of tasks. Stages and tasks are run in serial: once a task completes, the next task in the pipeline is executed.

Pipelines take a data object as input, and each task operates on the object in some way.

For an example of the Pipeliner in action, checkout the nxus-static-site module.

Installation

> npm install @nxus/pipeliner --save

Usage

Step 1: Define a pipeline

app.get('pipeliner').pipeline('my-pipeline')

Step 1a: Define stages

By default, every pipeline is pre-configured with three stages: 'collect', 'process', 'generate'. However, you can define your own stages:

app.get('pipliner').stages('my-pipeline', ['stage1', 'stage2', 'stage3'])

Step 2: Define tasks

A task is a javascript function that accepts any objects passed into the pipeline when it is run.

let myTask = (word) => {
  word.toUpperCase();
}

app.get('pipeliner').task('my-pipeline', 'process', myTask)

Step 3: Run a pipeline

Once all the tasks for a pipeline have been defined, the last step is to run the pipeline.

app.get('pipeliner').run('my-pipeline', someData)

API


index
Example
let myTask = (data) => {
  data.word.toUpperCase()
}
let data = {word: 'hello'}

let pipeliner = app.get('pipeliner')

pipeliner.pipeline('capitalize')
pipeliner.task('capitalize', 'process', myTask)
pipeliner.run('capitalize', data).then(() => {
  console.log('data') // {word: 'HELLO'}
})

Create a new pipeline.

pipeline(pipeline: string)
Parameters
pipeline (string) The name of the pipeline to create

Define stages for a pipeline

stages(stages: array, pipeline: string): [type]
Parameters
stages (array) An array of strings, each string being the name of a stage. Stages are executed in the order in the array.
pipeline (string) The name of the pipeline to use the stages.
Returns
[type]: [description]

Defintes a task for a pipeline and a stage.

task(pipeline: string, stage: string, job: function)
Parameters
pipeline (string) The name of the pipeline
stage (string) The name of the string
job (function) A function which accepts data

getPipelines

src/index.js

Returns all pipelines which have been defined

getPipelines(): object
Returns
object: A hash of the pipelines.

getPipeline

src/index.js

Returns a specific pipeline

getPipeline(pipeline: string): object
Parameters
pipeline (string) The name of a pipeline to return.
Returns
object: The pipeline object.

Runs the specified pipeline, passing the arguments to each task.

run(pipeline: string, args: ...object): Promise
Parameters
pipeline (string) the pipeline to run
args (...object) Arguments to pass to the pipeline tasks
Returns
Promise: A promise that is executed when the pipeline completes.