Package Exports

@cuties/cutie

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@cuties/cutie) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Cutie is a lightweight library that implements Async Tree Pattern.

Motivation

Let's say we want to read content from a file and write it to another one. And all these operations are asynchronous, of course. So, instead of writing something like this:

fs.readFile('./../file1.txt', 'utf8', (err, result) => {
  if (err != null) {
    throw err
  }
 
  fs.writeFile('./../file2.txt', result, (err) => {
    if (err != null) {
      throw err
    }
  })
})

we can design our code in the following style:

new WrittenFile(
  './../file2.txt',
  new ReadDataByPath('./../file1.txt', 'utf8')
).call()

How to use

You can use Cutie as a dependency via npm: npm install @cuties/cutie

const AsyncObject = require('@cuties/cutie').AsyncObject
const fs = require('fs')

class WrittenFile extends AsyncObject {

  constructor(path, content) {
    super(path, content)
  }
  
  definedAsyncCall() {
    return fs.writeFile
  }
  
}

const AsyncObject = require('@cuties/cutie').AsyncObject
const fs = require('fs')

class ReadDataByPath extends AsyncObject {
  constructor(path, encoding) {
    super(path, encoding);
  }
  
  definedAsyncCall() {
    return fs.readFile
  }
}

AsyncObject also provides methods OnResult and OnError, so that you can process the result from async call and handle an error in the specific way (error is being thrown by default).

Let's say we want to read a json file and parse all information from there. Cutie provides two ways. First of them is just to create ParsedJSON async object like this:

const AsyncObject = require('@cuties/cutie').AsyncObject;
const fs = require('fs');

class ParsedJSON extends AsyncObject {
  constructor(path, encoding) {
    super(path, encoding)
  }
  
  definedAsyncCall() {
    return fs.readFile
  }
  
  onResult(result) {
    return JSON.parse(result)
  }
}

// usage
new ParsedJSON('./../file.txt', 'utf8').call()

ParsedJSON also could be designed like this:

const fs = require('fs')
const ReadFile = require('./ReadFile')

class ParsedJSON extends ReadFile {
  constructor(path, encoding) {
    super(path, encoding)
  }
  
  onResult(result) {
    return JSON.parse(result)
  }
}

// usage
new ParsedJSON('./../file.txt', 'utf8').call();

Or you can use ReadFile with ParsedJSON that looks like this:

const AsyncObject = require('@cuties/cutie').AsyncObject
const fs = require('fs')
const ReadFile = require('./ReadFile')

class ParsedJSON extends AsyncObject {
  constructor(text) {
    super(text)
  }
  
  /*
    you can't call here async operations with I/O
  */
  definedSyncCall() {
    return JSON.parse
  }
}

// usage
new ParsedJSON(
  new ReadFile('./../file.txt', 'utf8')
).call()

Learn more.

Main idea

You can find more information about the main idea of cutie here. Also you can read about Async Tree Pattern here

Declarative events

Read.

As conception and sequence of async trees.

Read.

Run test

npm test

Run build

npm run build

Libraries that use cutie

node-test-executor, cutie-is, cutie-assert, cutie-fs, cutie-http, cutie-https, cutie-rest, cutie-buffer, cutie-error, cutie-date, cutie-json, cutie-event, cutie-stream, cutie-object, cutie-process, cutie-iterator, cutie-path, cutie-if-else, cutie-cluster, page-static-generator and many others.