Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.26 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.26 KB

🤞🏽 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