README.md

act

Inspired by do

How to install

npm i @mapogolions/act

Usage

How to use with CPS

const fs = require('fs')
const path = require('path')

function readFileAsJson(filename, encoding, next) {
  fs.readFile(filename, encoding, (err, content) => {
    if (err) {
      next(err)
      return;
    }
    try {
      const obj = JSON.parse(content)
      next(null, obj)
    } catch (err) {
      next(err)
    }
  });
}

function done(err, result) {
  if (err) {
    console.error(err.message)
    return;
  }
  console.log(result);
}

act(readFileAsJson, path.join(__dirname, 'package.json'), 'utf-8').call(null, done)

How to use with Promise

const fs = require('fs').promises
const path = require('path')

function readFileAsJson(filename, encoding, next) {
  fs.readFile(filename, encoding)
    .then(content => next(null, JSON.parse(content)))
    .catch(next)
}

function done(err, result) {
  if (err) {
    console.error(err.message)
    return;
  }
  console.log(result);
}

act(readFileAsJson, path.join(__dirname, 'package.json'), 'utf-8').call(null, done)

Reusable blocks

const fs = require('fs')
const path = require('path')

function parseContent(content, next) {
  setTimeout(() => {
    console.log('called once')
    try {
      next(null, JSON.parse(content))
    } catch (err) {
      next(err)
    }
  })
}

function getSetting(key, settings, next) {
  // the second argument (settings) will be provided by the `parseContent`
  setTimeout(next, 0, null, settings[key])
}

function done(err, result) {
  if (err) {
    console.error(err.message)
    return;
  }
  console.log(result);
}

// define block
const readSettings = act(fs.readFile, path.join(__dirname, 'package.json'), 'utf-8')
  .act(parseContent)
  .once()

// Note that if we DO NOT call `once` then fs.readFile and parseContent will be called for each branch
// `Once` caches the result and reuses it across branches
// Whether or not to use this kind of optimization depends on your task.
// In this example, `once` helps to avoid double reading and parsing

readSettings.act(getSetting, 'license').call(null, done)
readSettings.act(getSetting, 'version').call(null, done)

Also see unit tests for more details