Skip to content

Clarify docs for UIKit ifLet function #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 20, 2021
Merged

Clarify docs for UIKit ifLet function #497

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72cf825
Clarify docs for UIKit
mluisbrown Apr 19, 2021
ec0c6bf
Add clarification to override also
mluisbrown Apr 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions Sources/ComposableArchitecture/UIKit/IfLetUIKit.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ extension Store {
/// Subscribes to updates when a store containing optional state goes from `nil` to non-`nil` or
/// non-`nil` to `nil`.
///
/// **NOTE:** one of the `unwrap` or `else` closures is always called based on the *initial* state of the
/// optional state (`nil` or non-`nil`), in addition to subsequent changes of `nil` / non-`nil`.
///
/// This is useful for handling navigation in UIKit. The state for a screen that you want to
/// navigate to can be held as an optional value in the parent, and when that value switches
/// from `nil` to non-`nil` you want to trigger a navigation and hand the detail view a `Store`
Expand Down Expand Up @@ -35,9 +38,10 @@ extension Store {
///
/// - Parameters:
/// - unwrap: A function that is called with a store of non-optional state whenever the store's
/// optional state goes from `nil` to non-`nil`.
/// - else: A function that is called whenever the store's optional state goes from non-`nil` to
/// `nil`.
/// optional state is initially non-`nil` or goes from `nil` to non-`nil`.
/// - else: A function that is called whenever the store's optional state is initially `nil` or
/// goes from non-`nil` to `nil`.

/// - Returns: A cancellable associated with the underlying subscription.
public func ifLet<Wrapped>(
then unwrap: @escaping (Store<Wrapped, Action>) -> Void,
Expand Down Expand Up @@ -76,7 +80,7 @@ extension Store {
/// case.
///
/// - Parameter unwrap: A function that is called with a store of non-optional state whenever the
/// store's optional state goes from `nil` to non-`nil`.
/// store's optional state is initially non-`nil` or goes from `nil` to non-`nil`.
/// - Returns: A cancellable associated with the underlying subscription.
public func ifLet<Wrapped>(
then unwrap: @escaping (Store<Wrapped, Action>) -> Void
Expand Down