sjs/NotificationTask
1
0
Fork 0
mirror of https://github.com/samsonjs/NotificationTask.git synced 2026-03-31 10:15:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Actually write an overview in the readme

Browse source
This commit is contained in:
Sami Samhuri 2025-04-19 11:35:53 -07:00
parent dd679cfd49
commit c089cd253c
No known key found for this signature in database
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Readme.md
View file

@ -6,12 +6,19 @@
## Overview ## Overview
`NotificationTask` is 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 ## 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. 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 [file a new issue]: https://github.com/samsonjs/NotificationTask/issues/new
### Supported Platforms ### Supported Platforms
@ -46,7 +53,7 @@ import NotificationTask
} }
``` ```
Example using context to avoid reference cycles with `self`: This example uses the context parameter to avoid reference cycles with `self`:
```swift ```swift
import NotificationTask import NotificationTask