Sends an action to the store with a given transaction.
@discardableResult @MainActor func send(_ action: ViewAction, transaction: Transaction) -> StoreTask s22ComposableArchitecture9ViewStoreC4send_11transactionAA0D4TaskVq__7SwiftUI11TransactionVtF What are these?163SAAn action.
A transaction.
See send(_:) for more info.
import ComposableArchitectureThe Composable Architecture (TCA, for short) is a library for building applications in a consistent and understandable way, with composition, testing, and ergonomics in mind. It can be used in SwiftUI, UIKit, and more, and on any Apple platform (iOS, macOS, tvOS, and watchOS).
@dynamicMemberLookup @preconcurrency @MainActor final class ViewStore<ViewState, ViewAction>A ViewStore is an object that can observe state changes and send actions. They are most commonly used in views, such as SwiftUI views, UIView or UIViewController, but they can be used anywhere it makes sense to observe state or send actions.
@globalActor final actor MainActorA singleton actor whose executor is equivalent to the main dispatch queue.
struct StoreTaskThe type returned from send(_:) that represents the lifecycle of the effect started from sending an action.
@discardableResult @MainActor func send(_ action: ViewAction) -> StoreTask Sends an action to the store.
@discardableResult @MainActor func send(_ action: ViewAction, animation: Animation?) -> StoreTask Sends an action to the store with a given animation.
@MainActor func send(_ action: ViewAction, animation: Animation?, while predicate: @escaping (_ state: ViewState) -> Bool) async Sends an action into the store and then suspends while a piece of state is true.
Learn how to connect features written in the Composable Architecture to SwiftUI bindings.
nonisolated let objectWillChange: ObservableObjectPublisher@MainActor convenience init<State, Action>(_ store: Store<State, Action>, observe toViewState: @escaping (_ state: BindingViewStore<State>) -> ViewState, send fromViewAction: @escaping (_ viewAction: ViewAction) -> Action, removeDuplicates isDuplicate: @escaping (_ lhs: ViewState, _ rhs: ViewState) -> Bool) where ViewAction : BindableAction, State == ViewAction.State Initializes a structure that transforms a Store into an observable ViewStore in order to compute bindings from state.
@MainActor convenience init<State>(_ store: Store<State, ViewAction>, observe toViewState: @escaping (_ state: BindingViewStore<State>) -> ViewState, removeDuplicates isDuplicate: @escaping (_ lhs: ViewState, _ rhs: ViewState) -> Bool) where ViewAction : BindableAction, State == ViewAction.State Initializes a structure that transforms a Store into an observable ViewStore in order to compute bindings from state.
@MainActor convenience init<State, Action>(_ store: Store<State, Action>, observe toViewState: @escaping (_ state: BindingViewStore<State>) -> ViewState, send fromViewAction: @escaping (_ viewAction: ViewAction) -> Action) where ViewAction : BindableAction, State == ViewAction.State Initializes a structure that transforms a Store into an observable ViewStore in order to compute bindings from state.
@MainActor convenience init<State>(_ store: Store<State, ViewAction>, observe toViewState: @escaping (_ state: BindingViewStore<State>) -> ViewState) where ViewAction : BindableAction, State == ViewAction.State Initializes a structure that transforms a Store into an observable ViewStore in order to compute bindings from state.
@MainActor subscript<Value>(dynamicMember keyPath: WritableKeyPath<ViewState, BindingState<Value>>) -> Binding<Value> where Value : Equatable, Value : Sendable { get } @MainActor convenience init<State>(_ store: Store<State, ViewAction>, observe toViewState: @escaping (_ state: State) -> ViewState, removeDuplicates isDuplicate: @escaping (_ lhs: ViewState, _ rhs: ViewState) -> Bool) Initializes a view store from a store which observes changes to state.
@MainActor init<State, Action>(_ store: Store<State, Action>, observe toViewState: @escaping (_ state: State) -> ViewState, send fromViewAction: @escaping (_ viewAction: ViewAction) -> Action, removeDuplicates isDuplicate: @escaping (_ lhs: ViewState, _ rhs: ViewState) -> Bool) Initializes a view store from a store which observes changes to state.
@MainActor var publisher: StorePublisher<ViewState> { get }A publisher that emits when state changes.
@MainActor var state: ViewState { get }The current state.
@MainActor subscript<Value>(dynamicMember keyPath: KeyPath<ViewState, Value>) -> Value { get } Returns the resulting value of a given key path.
@MainActor func binding<Value>(get: @escaping (_ state: ViewState) -> Value, send valueToAction: @escaping (_ value: Value) -> ViewAction) -> Binding<Value> Derives a binding from the store that prevents direct writes to state and instead sends actions to the store.
@MainActor func binding<Value>(get: @escaping (_ state: ViewState) -> Value, send action: ViewAction) -> Binding<Value> Derives a binding from the store that prevents direct writes to state and instead sends actions to the store.
@MainActor func binding(send action: ViewAction) -> Binding<ViewState> Derives a binding from the store that prevents direct writes to state and instead sends actions to the store.
@MainActor func binding(send valueToAction: @escaping (_ state: ViewState) -> ViewAction) -> Binding<ViewState> Derives a binding from the store that prevents direct writes to state and instead sends actions to the store.
@MainActor func send(_ action: ViewAction, while predicate: @escaping (_ state: ViewState) -> Bool) async Sends an action into the store and then suspends while a piece of state is true.
@MainActor func yield(while predicate: @escaping (_ state: ViewState) -> Bool) async Suspends the current task while a predicate on state is true.