Giter Club home page Giter Club logo

sync-p's Introduction

sync-p

A tiny sync promise lib

features

sync-p is 55 lines of code, but handles the majority of the promise spec. Some of the spec is intentionally avoided, e.g.

  • sync-p is capable of returning synchronously, i.e. it does not defer everything
  • to avoid bloat sync-p assumes that truthy args passed to .then are functions (strict adherence involves explicitly handling cases like .then(5) ...like, just don't do that, that's not the api)
  • it does not throw if a promise is rejected and no reject handler is attached

installation

npm install sync-p

usage

var Promise = require('sync-p')

var result
var p = new Promise(function (resolve, reject) {
    // resolve immediately
    resolve(true)
  })
  .then(null, null)
  .then(function (val) {
    result = val
  })
console.log(result) // true

new Promise(function (resolve, reject) {
  throw 'error'
})
.catch(function (err) {
  console.log(err) // 'error'
})

var p = new Promise(function (resolve, reject) {
  setTimeout(function () {
    resolve(true)
  }, 0)
})
.then(onSuccess, onError)

var all = require('sync-p/all')

var p = all([1, 2, promise3]).then(function (val) {
  console.log(val) // [1, 2, 3]
})

var p = any([promise1, promise2, 3]).then(function (val) {
  console.log(val) // 3
})

var p = any([promise1, promise2, promise3]).catch(function (err) {
  console.log(err) // [err1, err2, err3]
})

// ... etc.

extra

var Promise = require('sync-p/extra')

// includes all, resolve, reject and defer
var promise = Promise.all(array)
var resolved = Promise.resolve(123)
var rejected = Promise.reject(321)
var deferred = Promise.defer()
var race = Promise.race(array)
var any = Promise.any(array)

run tests

npm test

Want to work on this for your day job?

This project was created by the Engineering team at Qubit. As we use open source libraries, we make our projects public where possible.

We’re currently looking to grow our team, so if you’re a JavaScript engineer and keen on ES2016 React+Redux applications and Node micro services, why not get in touch? Work with like minded engineers in an environment that has fantastic perks, including an annual ski trip, yoga, a competitive foosball league, and copious amounts of yogurt.

Find more details on our Engineering site. Don’t have an up to date CV? Just link us your Github profile! Better yet, send us a pull request that improves this project.` Contact GitHub API Training Shop Blog About

sync-p's People

Contributors

alanclarke avatar artxty avatar kaylequbit avatar tcolgate avatar upjonsavage avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

sync-p's Issues

Consider using the promise API

I know the promise API is all classy-statey-non-functional, the new keyword makes me sad but maybe it would be good to do it that way just because it is nice sometimes to slot in a module like this where native promises or some other library have been used before. (though I guess when also doesn't really conform either)

Another advantage would be that you don't have to learn or lookup different docs if you know the way to use native promises.

@alanclarke, @jimmed what do you think?

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.