https://github.com/ragzy15/publisherkit
An open source implementation of Apple's Combine framework for processing asynchronous events over time
https://github.com/ragzy15/publisherkit
carthage cocoapods combine combine-framework ios macos observer publisher-subscriber reactive reactive-programming swift swift-package-manager tvos watchos xcode
Last synced: 5 months ago
JSON representation
An open source implementation of Apple's Combine framework for processing asynchronous events over time
- Host: GitHub
- URL: https://github.com/ragzy15/publisherkit
- Owner: ragzy15
- License: mit
- Created: 2019-12-29T18:39:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-30T14:59:53.000Z (about 5 years ago)
- Last Synced: 2025-10-21T10:53:26.974Z (5 months ago)
- Topics: carthage, cocoapods, combine, combine-framework, ios, macos, observer, publisher-subscriber, reactive, reactive-programming, swift, swift-package-manager, tvos, watchos, xcode
- Language: Swift
- Homepage:
- Size: 973 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Publisher Kit
[](https://github.com/apple/swift-package-manager)
[](https://github.com/Carthage/Carthage)
[](https://img.shields.io/cocoapods/v/PublisherKit.svg)
## Overview
PublisherKit provides a declarative Swift API for processing asynchronous events over time. It is an open source version of Apple’s Combine Framework with many other additions.
The goal of this project is to provide a compatible, reliable and efficient implementation of Combine Framework that can be used on Apple’s operating systems older than macOS 10.15, iOS 13, tvOS 13 and watchOS 6.
To know more about Combine Framework, refer to Apple's Documentation [here](https://developer.apple.com/documentation/combine).
## Supported Platforms
* Xcode 11 and above
### Deployment Targets
* iOS 8 and above
* macOS (OS X) 10.10 and above
* tvOS 9 and above
* watchOS 3 and above
## Installation
### Swift Package Manager
To integrate PublisherKit into your project using [Swift Package Manager](https://swift.org/package-manager/), you can add the library as a dependency in Xcode (11 and above) – see the [docs](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app). The package repository URL is:
```bash
https://github.com/ragzy15/PublisherKit.git
```
Alternatively, you can add PublisherKit as a dependency in your `Package.swift` file. For example:
```swift
// swift-tools-version:5.1
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
let package = Package(
name: "YourPackage",
products: [
.library(
name: "YourPackage",
targets: ["YourPackage"]),
],
dependencies: [
.package(url: "https://github.com/ragzy15/PublisherKit.git", from: "4.0.2"),
],
targets: [
.target(
name: "YourPackage",
dependencies: ["PublisherKit"]),
]
)
```
You can install by using swift package manager built into Xcode or clone the repository and add a sub project into your project.
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects.
If you don't already have the Cocoapods gem installed, run the following command:
```bash
$ gem install cocoapods
```
To integrate PublisherKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '10.0'
use_frameworks!
pod 'PublisherKit', '~> 4.0.2'
```
Then, run the following command:
```bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your application.
You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
```bash
$ brew update
$ brew install carthage
```
To integrate PublisherKit into your Xcode project using Carthage, specify it in your `Cartfile`:
```ogdl
github "ragzy15/PublisherKit"
```
## Usage
```swift
searchTextField.textDidChangePublisher
.debounce(for: .milliseconds(300), scheduler: DispatchQueue.main)
.compactMap { (text) -> String? in
text.isEmpty ? nil : text
}
.removeDuplicates()
.flatMap { (text) -> AnyPublisher in
self.search(with: text)
}
.receive(on: DispatchQueue.main)
.sink { (results) in
print(results)
}
.store(in: &cancellables)
```
There is also a demo project included.
## Communication
* Please open an issue if you find a bug or have a feature request.
* Please submit a pull request if you would like to contribute (some tests would be nice).
Thanks ;)