callback/japgolly.scalajs.react.callback/CallbackOption

CallbackOption

final class CallbackOption[+A](val underlyingRepr: () => A) extends AnyVal

Callback that can short-circuit along the way when conditions you specify, aren't met.

Especially useful for event handlers such as key handlers, drag-and-drop handlers, etc, where you check a condition, perform an effect, check another condition, perform another effect, etc.

This is meant to be lightweight, and be immediately useful without the typical pain of imports, implicit conversions and extension methods then normally accompany monad transforms in Scala.

For a more generic (i.e. beyond Option) or comprehensive monad transformer use Cats or similar.

Companion
object
class AnyVal
trait Matchable
class Any

Value members

Concrete methods

inline def &&[B](b: CallbackOption[B]): CallbackOption[Unit]
inline def *>[B](next: CallbackOption[B]): CallbackOption[B]

Alias for >>.

Alias for >>.

Where >> is often associated with Monads, *> is often associated with Applicatives.

def <*[B](next: CallbackOption[B]): CallbackOption[A]

Sequence actions, discarding the value of the second argument.

Sequence actions, discarding the value of the second argument.

inline def <<[B](prev: CallbackOption[B]): CallbackOption[A]

Sequence a callback to run before this, discarding any value produced by it.

Sequence a callback to run before this, discarding any value produced by it.

def <<?[B](prev: Option[CallbackOption[B]]): CallbackOption[A]

Convenient version of << that accepts an Option

Convenient version of << that accepts an Option

def >>[B](next: CallbackOption[B]): CallbackOption[B]

Sequence a callback to run after this, discarding any value produced by this.

Sequence a callback to run after this, discarding any value produced by this.

inline def >>=[B](f: A => CallbackOption[B]): CallbackOption[B]

Alias for flatMap.

Alias for flatMap.

def asCallback: CallbackTo[Option[A]]
def filter(condition: A => Boolean): CallbackOption[A]
inline def filterNot(inline condition: A => Boolean): CallbackOption[A]
def flatMap[B](f: A => CallbackOption[B]): CallbackOption[B]
def flatMapCB[B](f: A => CallbackTo[B]): CallbackOption[B]
def flatMapOption[B](f: A => Option[B]): CallbackOption[B]
def getOrElse[AA >: A](default: => AA): CallbackTo[AA]
def handleError[AA >: A](f: Throwable => CallbackOption[AA]): CallbackOption[AA]
inline def map[B](f: A => B)(using inline ev: MapGuard[B]): CallbackOption[B]
def orElse[AA >: A](tryNext: CallbackOption[AA]): CallbackOption[AA]
@targetName("ext_toCallback")
inline def toCallback: Callback
Extension method from CallbackOption
def unary_!: CallbackOption[Unit]
Extension method from CallbackOption
inline def unless(inline cond: Boolean): CallbackOption[A]

Conditional execution of this callback. Reverse of when.

Conditional execution of this callback. Reverse of when.

Value Params
cond

The condition required to be false for this callback to execute.

Returns

Some result of the callback executed, else None.

def void: CallbackOption[Unit]

Discard the value produced by this callback.

Discard the value produced by this callback.

inline def voidExplicit[B](using inline ev: A <:< B): CallbackOption[Unit]

Discard the value produced by this callback.

Discard the value produced by this callback.

This method allows you to be explicit about the type you're discarding (which may change in future).

inline def when(inline cond: Boolean): CallbackOption[A]

Conditional execution of this callback.

Conditional execution of this callback.

Value Params
cond

The condition required to be true for this callback to execute.

inline def withFilter(inline condition: A => Boolean): CallbackOption[A]
def zip[B](cb: CallbackOption[B]): CallbackOption[(A, B)]
inline def |[AA >: A](inline tryNext: CallbackOption[AA]): CallbackOption[AA]

Alias for orElse.

Alias for orElse.

inline def |>[B](f: A => B)(using inline ev: MapGuard[B]): CallbackOption[B]

Alias for map.

Alias for map.

inline def ||[B](b: CallbackOption[B]): CallbackOption[Unit]

Concrete fields

val underlyingRepr: () => A