Skip to content

A get-only `BehaviorRelay ` that is (almost) equivalent to ReactiveSwift's `Property`

License

Notifications You must be signed in to change notification settings

inamiy/RxProperty

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RxProperty

A get-only BehaviorRelay that is (almost) equivalent to ReactiveSwift's Property.

This class is highly useful to encapsulate BehaviorRelay inside ViewModel so that other classes cannot reach its setter (unbindable) and make state management safer.

In short:

public final class 💩ViewModel<T> {
    // 💩 This is almost the same as `var state: T`.
    // DON'T EXPOSE VARIABLE!
    public let state = BehaviorRelay<T>(...)

    // 💩 Exposing `Observable` is NOT a good solution either
    // because type doesn't tell us that it contains at least one value
    // and we cannot even "extract" it.
    public var stateObservable: Observable<T> {
        return state.asObservable()
    }
}
public final class 👍ViewModel<T> {
    // 👍 Hide variable.
    private let _state = BehaviorRelay<T>(...)

    // 👍 `Property` is a better type than `Observable`.
    public let state: Property<T>
    
    public init() {
        self.state = Property(_state)
    }
}

Disclaimer

Since this library should rather go to RxSwift-core, there is no plan to release as a 3rd-party microframework for CocoaPods/Carthage /SwiftPackageManager.

(Swift Package Manager is supported in inamiy/RxProperty#5)

If you like it, please upvote ReactiveX/RxSwift#1118 and join the discussion. Current recommended way is to directly use the source code to your project.

License

MIT

About

A get-only `BehaviorRelay ` that is (almost) equivalent to ReactiveSwift's `Property`

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages