Objective-C implementation of jQuery-ish promises
Objective-C Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Classes
Project
Promises
.gitignore
CHANGELOG.md
LICENSE
Promises.podspec
README.md
Rakefile

README.md

iOS-Promises

Objective-C implementation of jQuery-ish promises.

Asynchronous code... blah blah blah... standard interface for... blah blah blah... handling asynchronous actions... blah blah blah... chaining callbacks.

Updates

Version Changes
0.1.2 then and fail blocks can be undefined now when using When (thanks brennanmke)
0.1.1 Fixed issue with EXC_BAD_ACCESS (thanks DanielMSchmidt)
0.1.0 Initial release

Features

  • Deferred objects (the controller for the promise) are used change state for promise behavior which triggers callbacks
  • Promise objects are really just read-only Deferred objects
  • Add done, fail, and always blocks to a Deferred or Promise object
    • Add 0 to many done, fail, and always blocks
    • Can use "then" method for shortcut to add one done, one fail, and one always block
  • Create a When object to link Promise objects together
    • The done block executes when all promise object states are "resolved"
    • The fail block executes when one promise object state is "rejected"
    • The always block executes when all promises are no longer pending

Installation

Drop-in Classes

Clone the repository and drop in the .h and .m files from the "Classes" directory into your project.

CocoaPods

Promises is available through CocoaPods, to install it simply add the following line to your Podfile:

pod 'Promises', '~> 0.1.1'

Examples

Deferred - resolving

Deferred *deferred1 = [Deferred deferred];
[deferred1 addDone:^(id value) {
    NSLog(@"WOOT - deferred1 is done - %@", value);
}];
[deferred1 resolveWith:@"Josh is awesome"];

Deferred - rejecting with a promise

Rejecting a deferred's promise (promise is the same as deferred but doesn't show method for resolving or rejecting.

This would be used if you wanted to return a promise from some method.

Deferred *deferred2 = [Deferred deferred];

Promise *promise = deferred2.promise;
[promise addDone:^(id value) {
    NSLog(@"WOOT - deferred2 is done - %@", value);
}];
[promise addFail:^(NSError *error) {
    // This fail block's parameter is of type 'id' but I know that it will be an NSError
    NSLog(@":( - deferred2 failed - %@", error.domain);
}];

[deferred2 rejectWith:[NSError errorWithDomain:@"Oops" code:0 userInfo:nil]];

When - chaining promises

Deferred *deferred1 = [Deferred deferred];
Deferred *deferred2 = [Deferred deferred];

[When when:@[deferred1, deferred2] then:^{
    NSLog(@"WHEN RESOLVING done called");
} fail:^(NSError *error) {
    NSLog(@"WHEN RESOLVING fail called - %@", error.domain);
} always:^{
    NSLog(@"WHEN RESOLVING always called");
}];

[deferred1 resolveWith:@"Yay"];
[deferred2 resolveWith:@"Woot"];

Author

Josh Holtz, me@joshholtz.com, @joshdholtz

License

Promises is available under the MIT license. See the LICENSE file for more info.