Specular.Ref

data Ref a

Constructors

• Ref (Dynamic a) ((a -> a) -> Effect Unit)

Instances

• Invariant Ref

new :: forall m a. MonadEffect m => a -> m (Ref a)

Create a new Ref with an initial value.

newWithEvent :: forall m a. MonadFRP m => a -> Event (a -> a) -> m (Ref a)

const :: forall a. a -> Ref a

Create a Ref with a value

value :: forall a. Ref a -> Dynamic a

The current value of the Ref, as a Dynamic.

modify :: forall a m. MonadEffect m => Ref a -> (a -> a) -> m Unit

Modify value of this Ref using a function.

read :: forall m a. MonadEffect m => Ref a -> m a

Read the current value of a Ref

write :: forall a m. MonadEffect m => Ref a -> a -> m Unit

Overwrite value of this Ref.

focusRef :: forall s a. Dynamic (Lens s a) -> Ref s -> Ref a

pureFocusRef :: forall s a. Lens s a -> Ref s -> Ref a

previewRef :: forall s a. Prism s a -> Ref s -> Ref (Maybe a)

wrapViewWidget :: forall m a. MonadWidget m => (WeakDynamic a -> m (Event a)) -> Ref a -> m Unit

type Lens s a = { get :: s -> a, set :: s -> a -> s }

type Prism s a = { preview :: s -> Maybe a, review :: a -> s }

newRef :: forall m a. MonadEffect m => a -> m (Ref a)

Old name for new.

newRefWithEvent :: forall m a. MonadFRP m => a -> Event (a -> a) -> m (Ref a)

Old name for newWithEvent

constRef :: forall a. a -> Ref a

Old name for const

readRef :: forall m a. MonadEffect m => Ref a -> m a

Old name for read

updateRef :: forall a m. MonadEffect m => Ref a -> a -> m Unit

set :: forall a m. MonadEffect m => Ref a -> a -> m Unit

Old name for write

refUpdateConst :: forall a m. MonadEffect m => Ref a -> a -> m Unit

Old name for write.

refValue :: forall a. Ref a -> Dynamic a

Old name for value

refUpdate :: forall a m. MonadEffect m => Ref a -> (a -> a) -> m Unit

Old name for modify.