PromiseKit README

The project's README from github.com/mxcl/PromiseKit. As one markdown file: README.md.

PromiseKit

badge-pod badge-languages badge-pms badge-platforms codecov

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 that has 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.

codecov

Quick Start

In your Podfile:

use_frameworks!

target "Change Me!" do
  pod "PromiseKit", "~> 8"
end

PromiseKit 8 supports recent Xcodes (13+). Some Podspecs were dropped as a result. Pull requests are welcome.

PromiseKit 6, 5 and 4 support Xcode 8.3, 9.x and 10.0; Swift 3.1, 3.2, 3.3, 3.4, 4.0, 4.1, 4.2, 4.3 and 5.0 (development snapshots); iOS, macOS, tvOS, watchOS, Linux and Android; CocoaPods, Carthage and SwiftPM; (CI Matrix).

For Carthage, SwiftPM, Accio, etc., or for instructions when using older Swifts or Xcodes, see our Installation Guide. We recommend Carthage or Accio.

PromiseKit and Swift 5.5+ Async/Await

As of Swift 5.5, the Swift language now offers support for built-in concurrency with async / await. See Async+ for a port of PromiseKit's most useful patterns to this new paradigm.

Professionally Supported PromiseKit is Now Available

TideLift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.

Get Professional Support for PromiseKit with TideLift.

Documentation

Extensions

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, e.g.:

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", "~> 8"

Note: Carthage installations come with no extensions by default.

Networking

Promise chains commonly start with a network operation. Thus, we offer extensions for URLSession:

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

firstly {
    URLSession.shared.dataTask(.promise, with: try makeUrlRequest()).validate()
    // ^^ we provide `.validate()` so that eg. 404s get converted to errors
}.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 JSONEncoder().encode(obj)
    return rq
}

Support for Alamofire is welcome, please submit a PR.

Support

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.

Security & Vulnerability Reporting or Disclosure

https://tidelift.com/security

PromiseKit (mxcl/PromiseKit)

Searching Database…

14.2K ·GitHub
PromiseKit
Что это такое?PromiseKit — это полноценная реализация промисов для Swift и Objective-C, которая упрощает асинхронное программирование: асинхронный код становится понятнее, читабельнее и легче осваивается.
Это библиотека, которую я добавляю в приложение, или отдельная утилита, которую запускаю?Это библиотека: вы добавляете её в свой проект на Swift или Objective-C через пакетный менеджер, и она работает внутри вашего приложения. Работает на любой платформе, где есть компилятор Swift.
Как добавить его в свой проект?Добавьте его в Podfile через CocoaPods или установите через Carthage, SwiftPM или Accio — в README рекомендуются Carthage или Accio. Для PromiseKit 8 нужен Xcode 13 или новее.
Он будет работать с моей версией Xcode и Swift?PromiseKit 8 поддерживает свежие версии Xcode (13+), ради этого часть podspec-ов была убрана. Старые линейки 6, 5 и 4 покрывают Xcode 8.3–10.0 и Swift с 3.1 до 5.0.
В Swift уже есть встроенный async/await — стоит ли всё ещё добавлять PromiseKit?Сам README указывает на Async+ — перенос самых полезных паттернов PromiseKit на новую парадигму async/await — как на современный аналог для кода на Swift 5.5+.
Он работает за пределами платформ Apple или только под iOS?Есть приятные спецсборки для iOS, macOS, tvOS и watchOS, но подойдёт любая платформа с компилятором swiftc, включая Linux — в старых версиях 4–6 значился даже Android.
Что дают расширения?PromiseKit переделал почти все API Apple так, что они возвращают промисы. Пакет CocoaPods по умолчанию включает расширения для Foundation и UIKit; остальные расширения — отдельные subspec-ы (в том числе URLSession для работы с сетью), а при установке через Carthage по умолчанию их нет вовсе.
PromiseKit используется в реальных продакшен-приложениях?Да — это CocoaPod из топ-100, который задействован во многих самых популярных приложениях в мире.
Можно ли пользоваться им из Objective-C?Да — у PromiseKit отличная обвязка для Objective-C, а в документации есть отдельный гайд по Objective-C.
Есть ли для команд платная профессиональная поддержка?Да — PromiseKit доступен через TideLift, которая даёт командам разработчиков профессиональные гарантии и сопровождение от экспертов, знающих его лучше всех.
What are similar projects?AFNetworking, CocoaLumberjack, Alamofire, SDWebImage, Mantle, firebase-ios-sdk, SwifterSwift, swift-composable-architecture
Which topics is it in?swift-package-manager, watchos, tvos, objective-c, concurrency, async, apple, swift, ios, android, library, cross-platform
Creator
mxcl
Size
10.4 MB
Stars
14.2K
Updated
CommitJun 03Release8.2.0Jan 16
Age
12y
Commits · 90 Days