Swift Package Index

PromiseK

https://github.com/koher/promisek.git

A simple Promise library for Swift


Compatibility

  • 3.1.1 and master
    5.3
    5.2
    5.1
    5.0
    4.2
  • 3.1.1 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS

PromiseK

PromiseK provides a simple monadic Promise type for Swift.

// `flatMap` is equivalent to `then` of JavaScript's `Promise`
let a: Promise<Int> = asyncGet(2)
let b: Promise<Int> = asyncGet(3).map { $0 * $0 } // Promise(9)
let sum: Promise<Int> = a.flatMap { a in b.map { b in a + b } }

Promise can collaborate with throws for failable asynchronous operations.

// Collaborates with `throws` for error handling
let a: Promise<() throws -> Int> = asyncFailable(2)
let b: Promise<() throws -> Int> = asyncFailable(3).map { try $0() * $0() }
let sum: Promise<() throws -> Int> = a.flatMap { a in b.map { b in try a() * b() } }

It is also possible to recover from errors.

// Recovery from errors
let recovered: Promise<Int> = asyncFailable(42).map { value in
    do {
        return try value()
    } catch _ {
        return -1
    }
}

Installation

Swift Package Manager

.package(
    url: "https://github.com/koher/PromiseK.git",
    from: "3.0.0"
)

Carthage

github "koher/PromiseK" ~> 3.0.0

License

The MIT License

References

  1. Promise - JavaScript | MDN
  2. JavaScript Promises: There and back again - HTML5 Rocks
  3. A Fistful of Monads - Learn You a Haskell for Great Good!