Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
avow - npm Package Compare versions
Comparing version 2.0.2 to 3.0.0
| { | ||
| "name": "avow", | ||
| "version": "2.0.2", | ||
| "description": "Example Promises/A+ implementation. Simple, tiny, fast, fully async", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git@github.com:briancavalier/avow.git" | ||
| }, | ||
| "keywords": ["promise", "promises", "promises-aplus", "Promises/A+", "async", "asynchronous", "deferred"], | ||
| "author": { | ||
| "name": "Brian Cavalier", | ||
| "email": "brian@hovercraftstudios.com" | ||
| }, | ||
| "main": "avow", | ||
| "devDependencies": { | ||
| "promises-aplus-tests": "~1", | ||
| "jshint": "~1" | ||
| }, | ||
| "scripts": { | ||
| "test": "jshint . && promises-aplus-tests test/avow-adapter.js" | ||
| } | ||
| "name": "avow", | ||
| "version": "3.0.0", | ||
| "description": "Proxy for assert that accepts custom Errors", | ||
| "main": "index.js", | ||
| "scripts": { | ||
| "test": "ava test" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/invisible-tech/avow.git" | ||
| }, | ||
| "keywords": [ | ||
| "assert", | ||
| "error" | ||
| ], | ||
| "author": "Invisible Technologies, Inc.", | ||
| "license": "MIT", | ||
| "bugs": { | ||
| "url": "https://github.com/invisible-tech/avow/issues" | ||
| }, | ||
| "homepage": "https://github.com/invisible-tech/avow#readme", | ||
| "devDependencies": { | ||
| "ava": "^0.18.2", | ||
| "eslint": "^3.18.0" | ||
| } | ||
| } |
107
README.md
| # avow | ||
| <a href="http://promises-aplus.github.com/promises-spec"><img src="http://promises-aplus.github.com/promises-spec/assets/logo-small.png" align="right" /></a> | ||
| Avow is a tiny, fast, fully asynchronous [Promises/A+](https://github.com/promises-aplus/promises-spec) implementation, and passes the [Promises/A+ Test Suite](https://github.com/promises-aplus/promises-tests). It tracks Promises/A+ and is currently *forward compatible* to the upcoming revision Promises/A+ (likely to be versioned 1.1.0). | ||
| Assertion library to allow one to throw custom errors. | ||
| It's around 150 lines of JS (sans comments, module boilerplate, and nextTick sniffing), under 650 bytes when closured+gzipped, supports unhandled rejection hooks for debugging, and is very fast in environments where a fast `nextTick` is available. It uses `process.nextTick` or `setImmediate` if available (you can use [NobleJS's setImmediate polyfill](https://github.com/NobleJS/setImmediate)), and will fall back to `setTimeout` (srsly, use the polyfill) otherwise. | ||
| `avow` uses ES2015 Proxies to intercept calls to `assert`. | ||
| All methods of `assert` are available, and it is compatible with both | ||
| `Node.js`'s standard assertion library and the one on `npm`. | ||
| ## Why? | ||
| ## Motivation | ||
| I wrote avow as a stripped-down test bed for new ideas for [when.js](https://github.com/cujojs/when), [cujo.js](http://cujojs.com)'s full-featured promise implementation. I also hope that it serves as a simple example implementation for others who might want to implement promises either as a learning exercise, or as a part of a project/library/framework. | ||
| To allow `assert` to throw custom errors. | ||
| ## Can I use it? | ||
| ## Example | ||
| Yes, but you shouldn't. You should try [when.js](https://github.com/cujojs/when) instead. It is even faster and provides many more features, like dealing with collections of promises, competitive races, and timed promises. | ||
| ## *Should* I use it? | ||
| Again, probably not. I have no plans to support it in any way. I'll probably change the API without warning like I did from 1.0.0 to 2.0.0. You're on your own. | ||
| ## Ok, ok, if you want to try it out | ||
| Download it, clone it, or `npm install avow` | ||
| ## The API | ||
| ### `assert` encapsulates Custom Errors under an AssertionError, which sucks | ||
| ```js | ||
| var avow = require('avow'); | ||
| const assert = require('assert') | ||
| assert(false, Error('yohoo') | ||
| // Create a promise | ||
| var promise = avow(function(resolve, reject) { | ||
| // ... do some work ... | ||
| // Resolve the returned promise with a value, another promise, | ||
| // or any well-behaved thenable. | ||
| resolve(value); | ||
| // resolve(anotherPromise); | ||
| // resolve(thenable); | ||
| // Or reject it | ||
| reject(reason); | ||
| }); | ||
| // Create a fulfilled promise | ||
| promise = avow.lift(nonPromiseValue); | ||
| // Create a promise whose fate follows another promise | ||
| promise = avow.lift(anotherPromise); | ||
| // Attempt to assimilate and follow a well-behaved thenable's fate | ||
| promise = avow.lift(thenable); | ||
| // Create a rejected promise that will use | ||
| promise = avow.rejected(reason); | ||
| { AssertionError: Error: yohoo | ||
| at Object.<anonymous> (/tmp/a/index.js:2:1) | ||
| name: 'AssertionError', | ||
| actual: false, | ||
| expected: true, | ||
| operator: '==', | ||
| message: | ||
| Error: yohoo | ||
| at Object.<anonymous> (/tmp/a/index.js:2:15) | ||
| generatedMessage: false } | ||
| ``` | ||
| ## Make your own | ||
| _Stack-trace trimmed for readability._ | ||
| You can make your own custom configured instance of avow: | ||
| ### `avow` throws Custom Errors properly, which is nice | ||
| ```js | ||
| var myAvow = require('avow').construct(options); | ||
| const avow = require('avow') | ||
| avow(false, Error('yohoo')) | ||
| Error: yohoo | ||
| at Object.<anonymous> (/tmp/a/index.js:2:16) | ||
| ``` | ||
| Where `options` is an object that can have any of the following properties: | ||
| _Stack-trace trimmed for readability._ | ||
| * `enqueue` - specify your own nextTick function | ||
| * `unhandled` - callback to be notified when a promise becomes rejected, but has no rejection handler. | ||
| * `handled` - callback to be notified if, at some point, a previously unhandled rejected promise become handled. Since promises are temporal, this can happen if a consumer adds a rejection handler using `then()` at some point after the promise has been rejected. | ||
| * `protect` - function that is called on every promise avow creates, to give you a chance to protect it, e.g. by supplying Object.freeze() here. | ||
| ## Installation | ||
| ## Running the Promises/A+ Test Suite | ||
| Make sure `assert` is installed. | ||
| 1. `npm install` | ||
| 1. `npm test` | ||
| ## Changelog | ||
| ### 2.0.1 | ||
| * Dodge Mocha `process` global | ||
| * Fix typo in Promises/A+ test adapter. Test results not affect. | ||
| ### 2.0.0 | ||
| * New API (I warned you!) | ||
| * Tracking forward compatibility with [Promises/A+](http://promises-aplus.github.com/promises-spec/) 1.1.0 | ||
| ### 1.0.0 | ||
| * Initial release | ||
| * [Promises/A+](http://promises-aplus.github.com/promises-spec/) 1.0.0 compliant | ||
| ## License | ||
| MIT License, Copyright (c) 2012-2013 Brian Cavalier | ||
| The `npm` library `assert` is not a `dependency` in `package.json` in order to | ||
| allow one to use `Node.js`'s standard `assert` library. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Improved metrics
- Number of package files
- increased by25%
5
Worsened metrics
- Total package byte prevSize
- decreased by-69.51%
3336
- Lines of code
- decreased by-89.83%
18
- Number of lines in readme file
- decreased by-46.87%
51
- Number of medium supply chain risk alerts
- increased byInfinity%
2
No dependency changes