Giter Club home page Giter Club logo

coone's Introduction

Acts like co@3 and also is drop-in replacement for it. Built on top of merz, actually thanks to always-done. But accept everything, not only generators - sync functions, async functions, callbacks and more. Flow-control for now and then.

code climate standard code style travis build status coverage status dependency status

Install

npm i coone --save

Usage

For more use-cases see the tests or try examples

Co-ify everything!

  • <val> {Function|GeneratorFunction|Stream|Promise} anything that merz accepts
  • return {Function} which accepts only callback (thunk)

Example

const coone = require('coone')

Generators

Same as in co@3, but better.

const fs = require('fs')

/**
 * readFile
 */

function read (fp) {
  return (done) => {
    fs.readFile(fp, 'utf8', done)
  }
}

coone(function * () {
  const data = yield read('package.json')
  return JSON.parse(data)
})((err, json) => {
  if (err) return console.error(err)
  console.log(json.name) // => 'coone'
})

JSON.stringify

Specific use-case which shows correct and working handling of optional arguments.

coone(JSON.stringify, {foo: 'bar'})((err, data)=> {
  if (err) return console.error(err)
  console.log(data) //=> {"foo":"bar"}
})

// result with identation
coone(JSON.stringify, {foo: 'bar'}, null, 2)((err, data) => {
  if (err) return console.error(err)
  console.log(data)
  // =>
  // {
  //   "foo": "bar"
  // }
})

callback-style and sync functions

Again, showing correct handling of optinal arguments using native fs module.

const fs = require('fs')

// callback function
coone(fs.stat, 'package.json')((err, res) => {
  if (err) return console.error(err)
  console.log(res.isFile()) //=> true
})

// correct handling of optional arguments
coone(fs.readFile, 'package.json')((err, buf) => {
  if (err) return console.error(err)
  console.log(Buffer.isBuffer(buf)) //=> true
})

// read json file and parse it,
// because it will be utf8 string
coone(fs.readFileSync, 'package.json', 'utf-8')((err, data) => {
  if (err) return console.error(err)
  console.log(data.name) //=> 'coone'
})

flatten multiple arguments by default

If you pass more than two arguments to the callback, they will be flattened by default.

coone((one, two, cb) => {
  cb(null, one, two, 33)
}, 11, 22)((err, res) => {
  if (err) return console.error(err)
  console.log(Array.isArray(res)) //=> true
  console.log(res) //=> [11, 22, 33]
})

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

tunnckocore.tk keybase tunnckocore tunnckoCore npm tunnckoCore twitter tunnckoCore github

coone's People

Contributors

tunnckocore avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

coone's Issues

refactor

'use strict'

var fs = require('fs')
var alwaysDone = require('always-done')

function coone (fn/*, ...args*/) {
  var self = this
  var args = [].slice.call(arguments, 1)
  return function thunk (done) {
    self = this || self
    return alwaysDone(fn, {
      context: self,
      args: args
    }, done)
  }
}

coone(fs.readFile, 'alwa.js', 'utf8')(console.log)
coone(function (a, b) {
  return a + b
}, 1, 2)(console.log) // => null, 3
coone(function (a, b, cb) {
  cb(null, a + b)
}, 1, 2)(console.log) // => null, 3

should add generator function support too

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.