Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hootsuite/emit
Simple signals library for Swift
https://github.com/hootsuite/emit
swift
Last synced: 6 days ago
JSON representation
Simple signals library for Swift
- Host: GitHub
- URL: https://github.com/hootsuite/emit
- Owner: hootsuite
- License: other
- Created: 2018-09-14T22:22:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-27T23:32:16.000Z (over 2 years ago)
- Last Synced: 2024-04-16T08:53:43.899Z (7 months ago)
- Topics: swift
- Language: Swift
- Homepage:
- Size: 1.36 MB
- Stars: 6
- Watchers: 11
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Emit
[](https://raw.githubusercontent.com/Carthage/Carthage/master/LICENSE.md)
[](https://github.com/Carthage/Carthage/releases)
[](https://hootsuite.github.io/emit/)
Emit is a simple signals library for Swift. It lets you emit strongly-typed events and you don't have to worry about disposing of subscriptions. Emit supports emit/subscribe, map, and filter. Which makes it ideal for keeping your code simple.
Emit has been developed for use in the Hootsuite iOS app.
## Deprecation Notice ⚠️
**Attention: Users of Emit**
We would like to inform you that Emit library has been deprecated and will no longer be maintained as of September 1, 2024. This decision was made after careful consideration due to availability of better alternatives, i.e. Combine
### What This Means for You
- **No New Features**: There will be no further development of new features for Emit.
- **Migration Recommendations**: We recommend users to migrate to Combine which has similar functionality and will be supported by Apple.
### Timeline
- **July 22, 2024**: Official deprecation announced.
- **September 1, 2024**: End of support and maintenance.
## Features
- Strongly-typed events
- Mapping and filtering of signals
- Observable variables
## Requirements
- iOS 11.0+, macOS 10.12+, tvOS 10.0+
- Xcode 10.1+
## Usage
### Signal
To create a signal you specify the event type that will passed to the subscription closure. You can also specify `Void` if you don't want to include an event.
```swift
// Create a signal
let loginCompleteSignal = Signal()
```
To subscribe to a signal you pass an owner. The owner needs to be an object (an instance of a `class` as opposed to a `struct`). When the owner gets released the subscriptions stops automatically. You may also pass a `DispatchQueue` that you would like the closure to be called on, the default is `DispatchQueue.main`.
```swift
// Subscribe to it
loginCompleteSignal.subscribe(owner: self) { result in
// Handle signal
}
```
To emit a signal simply call `emit` with the event value. Note that subscribers will be called on the next run loop of their specified queue.
```swift
// Emit an event
loginCompleteSignal.emit(true)
```
### ObservableVariable
Observable variables combine a value and a signal. The signal gets emitted every time the value changes.
```swift
let email = ObservableVariable("")
email.signal.subscribe(owner: self) { newEmail in
// Update UI with new email
}
email.value = "[email protected]" // This will emit the signal to update the UI
```
## Demo Project
See the demo project provided for example usage of the Emit framework.
## Installation
Emit can be installed using either [Carthage](https://github.com/Carthage/Carthage) or [CocoaPods](https://cocoapods.org/).
### Carthage
To integrate Emit into your Xcode project using Carthage, specify it in your Cartfile:
```
github "hootsuite/Emit"
```
### CocoaPods
First, add the following line to your Podfile:
```
pod 'Emit'
```
Second, install Emit into your project:
```
pod install
```
## License
Emit is released under the Apache License, Version 2.0. See [LICENSE.md](LICENSE.md) for details.