SubscriptionRef25

Constructors

makeconstConstructs a new SubscriptionRef from an initial value.

Models

SubscriptionRefinterfaceA mutable reference whose updates are serialized and published to subscribers.

Guards

isSubscriptionRefconstReturns true if the provided value is a SubscriptionRef.

Getters

getconstRetrieves the current value of the SubscriptionRef.getAndSetconstRetrieves the current value and sets a new value atomically, notifying subscribers of the change.getAndUpdateconstRetrieves the current value and updates it atomically with the result of applying a function, notifying subscribers of the change.getAndUpdateEffectconstRetrieves the current value and updates it atomically with the result of applying an effectful function, notifying subscribers of the change.getAndUpdateSomeconstRetrieves the current value and optionally updates the reference.getAndUpdateSomeEffectconstRetrieves the current value and optionally updates the reference effectfully.getUnsafeconstRetrieves the current value of the SubscriptionRef unsafely.

Changes

changesconstCreates a stream that emits the current value and all subsequent changes to the SubscriptionRef.

Modifications

modifyconstModifies the SubscriptionRef atomically with a function that computes a return value and a new value, notifying subscribers of the change.modifyEffectconstModifies the SubscriptionRef atomically with an effectful function that computes a return value and a new value, notifying subscribers of the change.modifySomeconstComputes a return value and optionally updates the reference.modifySomeEffectconstComputes a return value and optionally updates the reference effectfully.

Setters

setconstSets the value of the SubscriptionRef, notifying all subscribers of the change.setAndGetconstSets the value of the SubscriptionRef and returns the new value, notifying all subscribers of the change.

Updating

updateconstUpdates the value of the SubscriptionRef with the result of applying a function, notifying subscribers of the change.updateAndGetconstUpdates the value of the SubscriptionRef with the result of applying a function and returns the new value, notifying subscribers of the change.updateAndGetEffectconstUpdates the value of the SubscriptionRef with the result of applying an effectful function and returns the new value, notifying subscribers of the change.updateEffectconstUpdates the value of the SubscriptionRef with the result of applying an effectful function, notifying subscribers of the change.updateSomeconstApplies an update function to the current value.updateSomeAndGetconstApplies an optional update and returns the current value afterward.updateSomeAndGetEffectconstApplies an effectful optional update and returns the current value afterward.updateSomeEffectconstApplies an effectful update only when it produces a new value.