sjs/NotificationSmuggler
1
0
Fork 0
mirror of https://github.com/samsonjs/NotificationSmuggler.git synced 2026-03-25 08:25:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fill in readme and fix deployment targets

Browse source
This commit is contained in:
Sami Samhuri 2025-04-29 09:08:04 -07:00
parent a43dd347dd
commit 886c9238b6
No known key found for this signature in database
2 changed files with 37 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Package.swift
View file

@ -6,8 +6,8 @@ import PackageDescription
let package = Package(
name: "NotificationSmuggler",
platforms: [
.iOS(.v18),
.macOS(.v15),
.iOS(.v16),
.macOS(.v12),
],
products: [
// Products define the executables and libraries a package produces, making them visible to other packages.

37
Readme.md
View file

@ -6,11 +6,44 @@
## Overview
tkt
NotificationSmuggler is a tiny Swift package that makes it easy to embed strongly-typed values in `Notification`s, and extract them out on the receiving end as well. Nothing elaborate, it sneaks the contraband in the `userInfo` dictionary.
Declare a type conforming to `Smuggled` and then use the static method `Notification.smuggle(_:object:)` when posting the notification. On the receiving side of things you can use the extension methods `NotificationCenter.notifications(for:)` and `NotificationCenter.publisher(for:)` to observe the strongly-typed values without manually mapping them yourself.
If you have `Sendable` contraband then all of this will work nicely with Swift 6 and complete concurrency checking.
## Usage
tktk
### Define a smuggled payload
```swift
struct SomeNotification: Smuggled, Sendable {
let answer: Int
}
```
Your payload doesn't have to be Sendable but if it is then you have more flexibility.
The `Smuggled` protocol provides static `notificationName` and `userInfoKey` properties for you, should you need them. Generally you don't though.
### Post a notification
```swift
NotificationCenter.default.post(.smuggle(SomeNotification(answer: 42)))
```
This automatically sets the `.name`, `userInfo`, and optionally `.object` for the notification.
### Observe and extract contraband
```swift
Task {
// This is fine because SomeNotification is Sendable
for await notification in NotificationCenter.default.notifications(for: SomeNotification.self) {
print(notification.answer)
}
}
```
## Installation