From 027c612c832bd114e730773221b021eec53f8461 Mon Sep 17 00:00:00 2001 From: Amzd Date: Sat, 2 Jan 2021 12:35:18 +0100 Subject: [PATCH] Updated README and comments to PublishedObject --- README.md | 14 +++++++------- Sources/PublishedObject/PublishedObject.swift | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a8a5c05..25f5878 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# NestedPublished +# PublishedObject A property wrapper that forwards the objectWillChange of the wrapped ObservableObject to the enclosing ObservableObject's objectWillChange. @@ -7,11 +7,11 @@ Just like @Published this sends willSet events to the enclosing ObservableObject ```swift class Outer: ObservableObject { - @NestedPublished var innerNestedPublished: Inner + @PublishedObject var innerPublishedObject: Inner @Published var innerPublished: Inner init(_ value: Int) { - self.innerNestedPublished = Inner(value) + self.innerPublishedObject = Inner(value) self.innerPublished = Inner(value) } } @@ -27,12 +27,12 @@ class Inner: ObservableObject { func example() { let outer = Outer(1) - // Setting property on Outer (This will send an update with either @Published or @NestedPublished) - outer.innerNestedPublished = Inner(2) // outer.objectWillChange will be called + // Setting property on Outer (This will send an update with either @Published or @PublishedObject) + outer.innerPublishedObject = Inner(2) // outer.objectWillChange will be called outer.innerPublished = Inner(2) // outer.objectWillChange will be called - // Setting property on Inner (This will only send an update when using @NestedPublished) - outer.innerNestedPublished.value = 3 // outer.objectWillChange will be called !!! + // Setting property on Inner (This will only send an update when using @PublishedObject) + outer.innerPublishedObject.value = 3 // outer.objectWillChange will be called !!! outer.innerPublished.value = 3 // outer.objectWillChange will NOT be called } ``` diff --git a/Sources/PublishedObject/PublishedObject.swift b/Sources/PublishedObject/PublishedObject.swift index 270ae1d..27e74a5 100644 --- a/Sources/PublishedObject/PublishedObject.swift +++ b/Sources/PublishedObject/PublishedObject.swift @@ -52,10 +52,10 @@ public struct PublishedObject where Value.ObjectWillCha } } -/// Force NestedPublished when using ObservableObjects +/// Force PublishedObject when using ObservableObjects @available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *) extension Published where Value: ObservableObject { public init(wrappedValue: Value) { - fatalError("Use NestedPublished with ObservableObjects") + fatalError("Use PublishedObject with ObservableObjects") } }