https://github.com/cyberbeni/typednotificationcenter

Typed version of Apple's NotificationCenter to avoid forgetting setting parameters in the userInfo dictionary and needing to handle not having those parameters.
https://github.com/cyberbeni/typednotificationcenter

carthage ios linux macos swift

Last synced: 8 months ago
JSON representation

Typed version of Apple's NotificationCenter to avoid forgetting setting parameters in the userInfo dictionary and needing to handle not having those parameters.

• Host: GitHub
• URL: https://github.com/cyberbeni/typednotificationcenter
• Owner: Cyberbeni
• License: mit
• Created: 2019-05-05T14:32:52.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2025-02-26T10:01:51.000Z (over 1 year ago)
• Last Synced: 2025-04-23T01:54:50.111Z (about 1 year ago)
• Topics: carthage, ios, linux, macos, swift
• Language: Swift
• Homepage:
• Size: 497 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# TypedNotificationCenter

[![Code coverage](https://codecov.io/github/Cyberbeni/TypedNotificationCenter/coverage.svg?branch=master)](https://codecov.io/github/Cyberbeni/TypedNotificationCenter?branch=master) [![codebeat badge](https://codebeat.co/badges/a94b1565-4033-4efb-b60b-76ba952ff4ad)](https://codebeat.co/projects/github-com-cyberbeni-typednotificationcenter-master) [![GitHub release](https://img.shields.io/github/release/Cyberbeni/TypedNotificationCenter.svg)](https://GitHub.com/Cyberbeni/TypedNotificationCenter/releases/)

 [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)

 ![Platforms](https://img.shields.io/badge/platform-iOS%20%7C%20Linux%20%7C%20macOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![Swift Package Manager Compatible](https://img.shields.io/badge/SwiftPM-compatible-4BC51D.svg?style=flat)](https://swift.org/package-manager/) [![CocoaPods Compatible](https://img.shields.io/badge/CocoaPods-compatible-4BC51D.svg?style=flat)](https://cocoapods.org/pods/TypedNotificationCenter) 

This framework is about rethinking Apple's NotificationCenter to be more typesafe and about removing uncertainity of the needed value being present in the userInfo dictionary. It can be also used to handle NSNotification.Name subscriptions with better performance than NSNotificationCenter.

It is assumed that you already have (or at least know how to make) a DisposeBag-like system for keeping observations alive. (Observations are cleaned up when the observer token is deallocated)

## Example usage

### Typesafe API

```swift

// SampleNotification.swift

import TypedNotificationCenter

enum SampleNotification: TypedNotification {

    struct Payload {

        let type = "test"

    }

    typealias Sender = MyCustomView

}

```

```swift

// OtherFile.swift

// Observe a notification and execute a block with the sender and the payload

var observations = [TypedNotificationObservation]()

observations.append(TypedNotificationCenter.default.observe(SampleNotification.self, object: nil, block: { (sender, payload) in

    print(sender, payload)

}))

// Post a notification

TypedNotificationCenter.default.post(SampleNotification.self, sender: self, payload: SampleNotification.Payload())

// Stop observing the notification, this is also called when the observation object deinitializes

observation?.invalidate()

```

### Typesafe bridging

```swift

enum KeyboardWillShowNotification: BridgedNotification {

    public static var notificationName: Notification.Name = UIResponder.keyboardWillShowNotification

    public typealias Sender = NSNull

    public typealias Payload = KeyboardNotificationPayload

}

```

### 1:1 drop-in replacement for existing NSNotificationCenter usage

```swift

var observations = [TypedNotificationObservation]()

observations.append(TypedNotificationCenter.default.observe(NSLocale.currentLocaleDidChangeNotification, object: nil, queue: NSOperationQueue.mainQueue()) { notification in

    print("The user's locale changed to: \(NSLocale.currentLocale().localeIdentifier)")

})

```