mirror of
https://github.com/samsonjs/NotificationTask.git
synced 2026-03-25 09:15:55 +00:00
82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
# NotificationTask
|
|
|
|
[](https://0dependencies.dev)
|
|
[](https://swiftpackageindex.com/samsonjs/NotificationTask)
|
|
[](https://swiftpackageindex.com/samsonjs/NotificationTask)
|
|
|
|
## Overview
|
|
|
|
NotificationTask is a Swift library that provides a simple and easy-to-use way to manage Swift concurrency `Task`s that observe notifications. The `NotificationTask` class allows you to create tasks that receive notifications and call the given closure with each notification, and optionally also with a context parameter so you don't have to manage its lifetime.
|
|
|
|
It uses a Swift `Task` to ensure that all resources are properly cleaned up when the `NotificationTask` is cancelled or deallocated. This library is designed for use in view layer code, making it easy to integrate with your app's user interface and/or view-model layer.
|
|
|
|
That's it. It's pretty trivial. I just got tired of writing it over and over.
|
|
|
|
## Installation
|
|
|
|
Honestly you should probably just copy [NotificationTask.swift]() into your project.
|
|
|
|
The only way to install this package is with Swift Package Manager (SPM). Please [file a new issue][] or submit a pull-request if you want to use something else.
|
|
|
|
[NotificationTask.swift]: https://github.com/samsonjs/NotificationTask/blob/main/Sources/NotificationTask/NotificationTask.swift
|
|
[file a new issue]: https://github.com/samsonjs/NotificationTask/issues/new
|
|
|
|
### Supported Platforms
|
|
|
|
This package is supported on iOS 16.0+ and macOS 12.0+.
|
|
|
|
### Xcode
|
|
|
|
When you're integrating this into an app with Xcode then go to your project's Package Dependencies and enter the URL `https://github.com/samsonjs/NotificationTask` and then go through the usual flow for adding packages.
|
|
|
|
### Swift Package Manager (SPM)
|
|
|
|
When you're integrating this using SPM on its own then add this to the list of dependencies your Package.swift file:
|
|
|
|
```swift
|
|
.package(url: "https://github.com/samsonjs/NotificationTask.git", .upToNextMajor(from: "0.1.0"))
|
|
```
|
|
|
|
and then add `"NotificationTask"` to the list of dependencies in your target as well.
|
|
|
|
## Usage
|
|
|
|
The simplest example uses a closure that receives the notification:
|
|
|
|
```swift
|
|
import NotificationTask
|
|
|
|
@MainActor class SimplestVersion {
|
|
let task = NotificationTask(name: .NSCalendarDayChanged) { _ in
|
|
print("The date is now \(Date.now)")
|
|
}
|
|
}
|
|
```
|
|
|
|
This example uses the context parameter to avoid reference cycles with `self`:
|
|
|
|
```swift
|
|
import NotificationTask
|
|
|
|
@MainActor class WithContext {
|
|
var notificationTask: NotificationTask?
|
|
|
|
init() {
|
|
notificationTask = NotificationTask(name: .NSCalendarDayChanged, context: self) { _self, _ in
|
|
_self.dayChanged()
|
|
}
|
|
}
|
|
|
|
func dayChanged() {
|
|
print("The date is now \(Date.now)")
|
|
}
|
|
}
|
|
```
|
|
|
|
The closure is async so you can await in there if you need to.
|
|
|
|
## License
|
|
|
|
Copyright © 2025 [Sami Samhuri](https://samhuri.net) <sami@samhuri.net>. Released under the terms of the [MIT License][MIT].
|
|
|
|
[MIT]: https://sjs.mit-license.org
|