https://github.com/chadian/vouch

🤞🏽A Promises/A+ library, written in typescript. A fun experiment, but you probably wouldn't want to use this in production 😄
https://github.com/chadian/vouch

javascript promise promise-library vouch

Last synced: 19 days ago
JSON representation

🤞🏽A Promises/A+ library, written in typescript. A fun experiment, but you probably wouldn't want to use this in production 😄

• Host: GitHub
• URL: https://github.com/chadian/vouch
• Owner: chadian
• License: mit
• Created: 2016-11-14T04:43:01.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T12:10:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T04:46:57.053Z (about 1 month ago)
• Topics: javascript, promise, promise-library, vouch
• Language: TypeScript
• Homepage:
• Size: 192 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
🤞🏽 vouch


[![Build Status](https://travis-ci.org/chadian/vouch.svg?branch=master)](https://travis-ci.org/chadian/vouch)

[![npm](https://img.shields.io/npm/v/vouch-promise.svg)](https://www.npmjs.com/package/vouch-promise)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/chadian/vouch/blob/master/LICENSE.txt)

A typescript promise library designed against the Promises/A+ specification. It has been tested with the [Promises/A+ test suite](https://github.com/promises-aplus/promises-tests) 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