Swiftpack.co - Package - mxcl/PromiseKit


badge-pod badge-languages badge-pms badge-platforms Build Status

繁體中文 (outdated), 简体中文 (outdated)

Promises simplify asynchronous programming, freeing you up to focus on the more important things. They are easy to learn, easy to master and result in clearer, more readable code. Your co-workers will thank you.

UIApplication.shared.isNetworkActivityIndicatorVisible = true

let fetchImage = URLSession.shared.dataTask(.promise, with: url).compactMap{ UIImage(data: $0.data) }
let fetchLocation = CLLocationManager.requestLocation().lastValue

firstly {
    when(fulfilled: fetchImage, fetchLocation)
}.done { image, location in
    self.imageView.image = image
    self.label.text = "\(location)"
}.ensure {
    UIApplication.shared.isNetworkActivityIndicatorVisible = false
}.catch { error in
    self.show(UIAlertController(for: error), sender: self)

PromiseKit is a thoughtful and complete implementation of promises for any platform with a swiftc, it has excellent Objective-C bridging and delightful specializations for iOS, macOS, tvOS and watchOS. It is a top-100 pod used in many of the most popular apps in the world.


PromiseKit 6 Released

PromiseKit 6 has been released; read the release notes and migration guide.

Quick Start

In your Podfile:


target "Change Me!" do
  pod "PromiseKit", "~> 6.0"

PromiseKit 6, 5 and 4 support Xcode 8.3, 9.0, 9.1, 9.2 and 9.3; Swift 3.1, 3.2, 3.3, 4.0 and 4.1 ; iOS, macOS, tvOS, watchOS, Linux and Android; CocoaPods, Carthage and SwiftPM; (CI Matrix).

For Carthage, SwiftPM, etc., or for instructions when using older Swifts or Xcodes see our Installation Guide. Please note that we sincerely recommend Carthage.


If you are looking for a function’s documentation, then please note our sources are thoroughly documented.


Promises are only as useful as the asynchronous tasks they represent, thus we have converted (almost) all of Apple’s APIs to promises. The default CocoaPod provides Promises and the extensions for Foundation and UIKit. The other extensions are available by specifying additional subspecs in your Podfile, eg:

pod "PromiseKit/MapKit"          # MKDirections().calculate().then { /*…*/ }
pod "PromiseKit/CoreLocation"    # CLLocationManager.requestLocation().then { /*…*/ }

All our extensions are separate repositories at the PromiseKit organization.

I don't want the extensions!

Then don’t have them:

pod "PromiseKit/CorePromise", "~> 6.0"

Note Carthage installations come with no extensions by default.

Choose Your Networking Library

Promise chains are commonly started with networking, thus we offer Alamofire:

// pod 'PromiseKit/Alamofire'  # https://github.com/PromiseKit/Alamofire-

firstly {
        .request("http://example.com", method: .post, parameters: params)
}.done { foo in
}.catch { error in


// pod 'PromiseKit/OMGHTTPURLRQ'  # https://github.com/PromiseKit/OMGHTTPURLRQ

firstly {
    URLSession.shared.POST("http://example.com", JSON: params)
}.map {
    try JSONDecoder().decoder(Foo.self, with: $0.data)
}.done { foo in
}.catch { error in

And (of course) plain URLSession:

// pod 'PromiseKit/Foundation'  # https://github.com/PromiseKit/Foundation

firstly {
    URLSession.shared.dataTask(.promise, with: try makeUrlRequest())
}.map {
    try JSONDecoder().decode(Foo.self, with: $0.data)
}.done { foo in
}.catch { error in

func makeUrlRequest() throws -> URLRequest {
    var rq = URLRequest(url: url)
    rq.httpMethod = "POST"
    rq.addValue("application/json", forHTTPHeaderField: "Content-Type")
    rq.addValue("application/json", forHTTPHeaderField: "Accept")
    rq.httpBody = try JSONSerialization.jsonData(with: obj)
    return rq

Nowadays, considering that:

  • We almost always POST JSON
  • We now have JSONDecoder
  • PromiseKit now has map and other functional primitives

We recommend vanilla URLSession; use less black-boxes, stick closer to the metal. Alamofire was essential until the three bulletpoints above became true, but nowadays it isn’t really necessary. OMGHTTPURLRQ was developed before JSON was the modern standard and thus REST requests were hard, but nowadays you rarely network anything but JSON.


Please check our Troubleshooting Guide and if after that you still have a question ask at our Gitter chat channel or on our bug tracker.


Stars: 9294
Help us keep the lights on



6.2.2 - Mar 28, 2018

6.2.3 - Mar 28, 2018

6.2.1 - Mar 4, 2018

  • Alamofire — Support Custom Serializers (PromiseKit/Alamofire@33c652a9b1b6a3a2f0eb06d082ec312682350e59)
  • Alamofire — Extended responseDecodable for JSONDecoder injection (PromiseKit/Alamofire@ddf0e15793970e538722f9b20737d196f6da6c35)

6.2.0 - Feb 28, 2018

We removed the deprecations for flatMap and map since it caused ambiguity.

1.7.6 - Feb 22, 2018