Git Product home page Git Product logo

vouch's Introduction

๐Ÿคž๐Ÿฝ vouch

Build Status npm license

A typescript promise library designed against the Promises/A+ specification. It has been tested with the Promises/A+ test suite so it should work other promise libraries and implementations.

Installation

To install using npm: npm install vouch-promise

or with yarn: yarn add vouch-promise

Usage

Within a typescript project

This project was created was written in typescript and has been published with its types. After it's been installed it can be imported like this: import { Vouch } from 'vouch-promise';

Within a node + commonjs project

It can also be used within a node project, using commonjs: const { Vouch } = require('vouch-promise');

Releasing

Run npm run release to release vouch.

This will:

  • Bump the version in the package.json
  • Tag the release with the release
  • Publish the package to npm

vouch's People

Contributors

ccdexcom avatar chadian avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

shivamwu

vouch's Issues

Terminology refactor

Review spec for terms and update where necessary.

  • Change lib/thenable to lib/vouchable

Prepare for nodeland

Make sure vouch can be require'd and used in a node setting

  • Write tests for node-type usage
  • Add usage section to README.md
  • Publish to npm (see #5)

Add testing around npm publish

Write a few tests that ensure that the npm compile script produces an output that works. The goal is not to publish something to npm that would possibly be breaking output. Specifically tests that cover the prepublish condition and what gets sent to npm.

Add Travis CI

Add git hook to run mocha tests through a Travis CI

Setup semantic-release

In an effort to better support semantic versioning for this module I intend to use semantic-release npm module to facilitate meaningful commit messages, changelogs, and semantic versioning.

Utils refactor

Move utils into their own folder in the root, in their own js file, and add tests.

  • include that gnarly once function

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.