https://github.com/ruby0x1/hxpromise
hxpromise
https://github.com/ruby0x1/hxpromise
Last synced: about 1 month ago
JSON representation
hxpromise
- Host: GitHub
- URL: https://github.com/ruby0x1/hxpromise
- Owner: ruby0x1
- License: other
- Created: 2015-03-14T22:18:55.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2020-06-12T17:01:01.000Z (almost 5 years ago)
- Last Synced: 2025-01-29T09:45:15.534Z (3 months ago)
- Language: Haxe
- Size: 21.5 KB
- Stars: 7
- Watchers: 6
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# hxpromise
An ES6 _based_ [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
) library for [Haxe](http://haxe.org).
Documentation can be found in the code file, but mirrors the documentation from [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), licensed under CC-BY-SA 2.5. by Mozilla Contributors.
## Active development
Please note this library is usable but needs more testing,
potentially more error handling features, potentially some changes
in how the queue is fulfilled (macro vs micro tasks) and so on.
Feedback and testing appreciated, and some issues are already filed.
## Examples
See [Examples.hx](https://github.com/underscorediscovery/hxpromise/blob/master/tests/Example.hx)
See also: [es6 promises tutorial](http://www.html5rocks.com/en/tutorials/es6/promises/)
```haxe
var get = new Promise(
function(resolve, reject) {
//call one or the other, not both
//reject('uh oh');
//resolve('u5-val');
}
);
get.then(
function(val:String){
//if success
trace('u5-val');
}
).error(
function(reason:String) {
//if failure
trace('u5 catch: $reason');
}
).then(
function() {
//no matter what the state was
trace('u5 always');
}
)
```
## flags/defines
- `hxpromise_dont_throw_unhandled_rejection`
- define this to prevent unhandled rejections from calling `throw`
- `hxpromise_catch_and_reject_on_promise_body`
- define this to wrap the call of the promise in a try block, the resulting catch will reject the promise.
- take note that if you do this - and don't use .error, you can miss exceptions and have no relevant stack.
## Goals
- es6 spec based
- light weight
- no dependency
- single file / drop in and use elsewhere
- no hijinx/complexity debt
## License
MIT. See LICENSE.md
## Differences from spec
- `catch` function is called `error`. catch is a keyword in Haxe.
- No event loop internally. Call `Promises.step` to propagate.
- You must call it somewhere. This library will not try to guess your intent.
- Call once per frame, or multiple times per "microtask" if you want
- `Promises` instead of `Promise` for user facing API, as the step is "internal" almost.
- `throw`/exceptions are not spec based
- exceptions thrown in a promise body will reject the promise
- but only if hxpromise_catch_and_reject_on_promise_body is defined
- exceptions not handled with `error` will bubble to the next frame and throw
- (this can be disabled, but not a good idea, since ghost exceptions are awful)
- `hxpromise_dont_throw_unhandled_rejection`
- exceptions thrown in `error` will not be captured and throw properly
- there is no connection between promises by proximity
- (i.e nesting promises by scope alone means nothing, as in the spec)
- `resolve` doesn't chain if the value handed in is a promise (:todo: 1.1.0)
## todo
- Externs for js Promise to use native type.
- This isn't widely supported in major browsers yet.
- Tests: will add more tests in an automated form soon
- Test more targets (tested: cpp, js, neko)
- Just basic haxe functions, so should work elsewhere
##History
0.1.0 - Dev
* initial implementation