Instance Methodswift-composable-architecture 1.18.0ComposableArchitecture
debounce(id:for:scheduler:options:)
Turns an effect into one that can be debounced.
func debounce<S>(id: some Hashable & Sendable, for dueTime: S.SchedulerTimeType.Stride, scheduler: S, options: S.SchedulerOptions? = nil) -> Effect<Action> where S : Scheduler Parameters
Returns
An effect that publishes events only after a specified time elapses.
To turn an effect into a debounce-able one you must provide an identifier, which is used to determine which in-flight effect should be canceled in order to start a new effect. Any hashable value can be used for the identifier, such as a string, but you can add a bit of protection against typos by defining a new type that conforms to Hashable, such as an enum:
case let .textChanged(text):
enum CancelID { case search }
return .run { send in
await send(
.searchResponse(
TaskResult { await self.apiClient.search(text) }
)
)
}
.debounce(id: CancelID.search, for: 0.5, scheduler: self.mainQueue)