Version v3.0.1

Author: minuscorp

Mini-Swift.podspec

@@ -2,7 +2,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'Mini-Swift'
-  s.version          = '3.0.0'
+  s.version          = '3.0.1'
   s.swift_version    = '5.0'
   s.summary          = 'The minimal expression of a Flux architecture in Swift.'
 

Package.resolved

@@ -77,9 +77,9 @@
         "package": "Nimble",
         "repositoryURL": "https://github.com/Quick/Nimble",
         "state": {
-          "branch": null,
-          "revision": "b02b00b30b6353632aa4a5fb6124f8147f7140c0",
-          "version": "8.0.5"
+          "branch": "master",
+          "revision": "eea5843b34beb559dd51cf004953f75028e47add",
+          "version": null
         }
       },
       {

Package.swift

@@ -38,17 +38,17 @@ let package = Package(
         .package(url: "https://github.com/ReactiveX/RxSwift.git", .upToNextMajor(from: "5.0.0")),
         .package(url: "https://github.com/apple/swift-nio.git", .upToNextMajor(from: "2.7.1")),
         // Development
-        .package(url: "https://github.com/Quick/Nimble", .branch("master")), // dev
-        .package(url: "https://github.com/mattgallagher/CwlPreconditionTesting", .branch("master")), // dev
-        .package(url: "https://github.com/minuscorp/ModuleInterface", from: "0.0.1"), // dev
-        .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.35.8"), // dev
-        .package(url: "https://github.com/jpsim/SourceKitten", from: "0.26.0"), // dev
-        .package(url: "https://github.com/shibapm/Rocket", from: "0.4.0"), // dev
-        .package(url: "https://github.com/Realm/SwiftLint", from: "0.35.0"), // dev
-        .package(url: "https://github.com/eneko/SourceDocs", from: "0.6.1"), // dev
-        .package(url: "https://github.com/shibapm/PackageConfig.git", from: "0.12.2"), // dev
-        .package(url: "https://github.com/shibapm/Komondor.git", from: "1.0.0"), // dev
-        .package(url: "https://github.com/Carthage/Commandant.git", .exact("0.17.0")), // dev
+//        .package(url: "https://github.com/Quick/Nimble", .branch("master")), // dev
+//        .package(url: "https://github.com/mattgallagher/CwlPreconditionTesting", .branch("master")), // dev
+//        .package(url: "https://github.com/minuscorp/ModuleInterface", from: "0.0.1"), // dev
+//        .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.35.8"), // dev
+//        .package(url: "https://github.com/jpsim/SourceKitten", from: "0.26.0"), // dev
+//        .package(url: "https://github.com/shibapm/Rocket", from: "0.4.0"), // dev
+//        .package(url: "https://github.com/Realm/SwiftLint", from: "0.35.0"), // dev
+//        .package(url: "https://github.com/eneko/SourceDocs", from: "0.6.1"), // dev
+//        .package(url: "https://github.com/shibapm/PackageConfig.git", from: "0.12.2"), // dev
+//        .package(url: "https://github.com/shibapm/Komondor.git", from: "1.0.0"), // dev
+//        .package(url: "https://github.com/Carthage/Commandant.git", .exact("0.17.0")), // dev
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
@@ -73,7 +73,7 @@ let package = Package(
             name: "MiniPromises",
             dependencies: ["Mini"]
         ),
-        .testTarget(name: "MiniSwiftTests", dependencies: ["Mini", "MiniTasks", "MiniPromises", "TestMiddleware", "NIOConcurrencyHelpers", "RxSwift", "Nimble", "RxTest", "RxBlocking"]), // dev
+//        .testTarget(name: "MiniSwiftTests", dependencies: ["Mini", "MiniTasks", "MiniPromises", "TestMiddleware", "NIOConcurrencyHelpers", "RxSwift", "Nimble", "RxTest", "RxBlocking"]), // dev
     ],
     swiftLanguageVersions: [.version("5.1")]
 )

docs/MiniTasks.swift

@@ -98,15 +98,47 @@ extension ObservableType where Self.Element: Mini.StateType {
 }
 
 extension PrimitiveSequenceType where Self: RxSwift.ObservableConvertibleType, Self.Trait == RxSwift.SingleTrait {
+    /**
+     Dispatches an given action from the result of the `Single` trait. This is only usable when the `Action` is a `CompletableAction`.
+     - Parameter action: The `CompletableAction` type to be dispatched.
+     - Parameter dispatcher: The `Dispatcher` object that will dispatch the action.
+     - Parameter mode: The `Dispatcher` dispatch mode, `.async` by default.
+     - Parameter fillOnError: The payload that will replace the action's payload in case of failure.
+     */
     public func dispatch<A>(action: A.Type, on dispatcher: Mini.Dispatcher, mode: Mini.Dispatcher.DispatchMode.UI = .async, fillOnError errorPayload: A.Payload? = nil) -> RxSwift.Disposable where A: MiniTasks.CompletableAction, Self.Element == A.Payload
 
+    /**
+     Dispatches an given action from the result of the `Single` trait. This is only usable when the `Action` is a `CompletableAction`.
+     - Parameter action: The `CompletableAction` type to be dispatched.
+     - Parameter key: The key associated with the `Task` result.
+     - Parameter dispatcher: The `Dispatcher` object that will dispatch the action.
+     - Parameter mode: The `Dispatcher` dispatch mode, `.async` by default.
+     - Parameter fillOnError: The payload that will replace the action's payload in case of failure or `nil`.
+     */
     public func dispatch<A>(action: A.Type, key: A.Key, on dispatcher: Mini.Dispatcher, mode: Mini.Dispatcher.DispatchMode.UI = .async, fillOnError errorPayload: A.Payload? = nil) -> RxSwift.Disposable where A: MiniTasks.KeyedCompletableAction, Self.Element == A.Payload
 
+    /**
+     Builds a `CompletableAction` from a `Single`
+     - Parameter action: The `CompletableAction` type to be built.
+     - Parameter fillOnError: The payload that will replace the action's payload in case of failure or `nil`.
+     - Returns: A `Single` of the `CompletableAction` type declared by the action parameter.
+     */
     public func action<A>(_ action: A.Type, fillOnError errorPayload: A.Payload? = nil) -> RxSwift.Single<A> where A: MiniTasks.CompletableAction, Self.Element == A.Payload
 }
 
 extension PrimitiveSequenceType where Self.Element == Never, Self.Trait == RxSwift.CompletableTrait {
+    /**
+     Dispatches an given action from the result of the `Completable` trait. This is only usable when the `Action` is an `EmptyAction`.
+     - Parameter action: The `CompletableAction` type to be dispatched.
+     - Parameter dispatcher: The `Dispatcher` object that will dispatch the action.
+     - Parameter mode: The `Dispatcher` dispatch mode, `.async` by default.
+     */
     public func dispatch<A>(action: A.Type, on dispatcher: Mini.Dispatcher, mode: Mini.Dispatcher.DispatchMode.UI = .async) -> RxSwift.Disposable where A: MiniTasks.EmptyAction
 
+    /**
+     Builds an `EmptyAction` from a `Completable`
+     - Parameter action: The `EmptyAction` type to be built.
+     - Returns: A `Single` of the `EmptyAction` type declared by the action parameter.
+     */
     public func action<A>(_ action: A.Type) -> RxSwift.Single<A> where A: MiniTasks.EmptyAction
 }