Skip to content

Commit 027c612

Browse files
committed
Updated README and comments to PublishedObject
1 parent cf8c209 commit 027c612

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# NestedPublished
1+
# PublishedObject
22

33
A property wrapper that forwards the objectWillChange of the wrapped ObservableObject to the enclosing ObservableObject's objectWillChange.
44

@@ -7,11 +7,11 @@ Just like @Published this sends willSet events to the enclosing ObservableObject
77

88
```swift
99
class Outer: ObservableObject {
10-
@NestedPublished var innerNestedPublished: Inner
10+
@PublishedObject var innerPublishedObject: Inner
1111
@Published var innerPublished: Inner
1212

1313
init(_ value: Int) {
14-
self.innerNestedPublished = Inner(value)
14+
self.innerPublishedObject = Inner(value)
1515
self.innerPublished = Inner(value)
1616
}
1717
}
@@ -27,12 +27,12 @@ class Inner: ObservableObject {
2727
func example() {
2828
let outer = Outer(1)
2929

30-
// Setting property on Outer (This will send an update with either @Published or @NestedPublished)
31-
outer.innerNestedPublished = Inner(2) // outer.objectWillChange will be called
30+
// Setting property on Outer (This will send an update with either @Published or @PublishedObject)
31+
outer.innerPublishedObject = Inner(2) // outer.objectWillChange will be called
3232
outer.innerPublished = Inner(2) // outer.objectWillChange will be called
3333

34-
// Setting property on Inner (This will only send an update when using @NestedPublished)
35-
outer.innerNestedPublished.value = 3 // outer.objectWillChange will be called !!!
34+
// Setting property on Inner (This will only send an update when using @PublishedObject)
35+
outer.innerPublishedObject.value = 3 // outer.objectWillChange will be called !!!
3636
outer.innerPublished.value = 3 // outer.objectWillChange will NOT be called
3737
}
3838
```

Sources/PublishedObject/PublishedObject.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ public struct PublishedObject<Value: ObservableObject> where Value.ObjectWillCha
5252
}
5353
}
5454

55-
/// Force NestedPublished when using ObservableObjects
55+
/// Force PublishedObject when using ObservableObjects
5656
@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)
5757
extension Published where Value: ObservableObject {
5858
public init(wrappedValue: Value) {
59-
fatalError("Use NestedPublished with ObservableObjects")
59+
fatalError("Use PublishedObject with ObservableObjects")
6060
}
6161
}

0 commit comments

Comments
 (0)