Type Alias Reactive<V>

A Reactive

type Reactive<V> = {
    dispose(reason: string): void;
    isDisposed(): boolean;
    on(handler: (value: Passed<V>) => void): Unsubscriber;
    onValue(handler: (value: V) => void): Unsubscriber;
    set(value: V): void;
}

Type Parameters

V

Index

Methods

dispose isDisposed on onValue set?

Methods

dispose

dispose(reason: string): void
Disposes the reactive, providing a reason for debug tracing
Parameters
- reason: string
Returns void
- Defined in types.ts:335

isDisposed

isDisposed(): boolean
Returns true if Reactive is disposed

Returns boolean
- Defined in types.ts:339

on

on(handler: (value: Passed<V>) => void): Unsubscriber
Subscribes to a reactive. Receives data as well as signals. Use onValue if you just care about values.

Return result unsubscribes.
```
const unsub = someReactive.on(msg => {
   // Do something with msg.value
});

unsub(); // Unsubscribe
```
Parameters
- handler: (value: Passed<V>) => void
Returns Unsubscriber
- Defined in types.ts:323

onValue

onValue(handler: (value: V) => void): Unsubscriber
Subscribes to a reactive's values. Returns a function that unsubscribes.
Parameters
- handler: (value: V) => void
Returns Unsubscriber
- Defined in types.ts:329

`Optional`set

set(value: V): void
Optional 'set' to write a value. Use ReactiveWritable if you want this non-optional
Parameters
- value: V
Returns void
- Defined in types.ts:344