Interface IObservableValue

Interface for an Observable object that represents an opaque JSON value.

interface IObservableValue {
    changed: ISignal<IObservableValue, ObservableValue.IChangedArgs>;
    isDisposed: boolean;
    type: "Value";
    dispose(): void;
    get(): undefined | PartialJSONValue;
    set(value: PartialJSONValue): void;
}

Hierarchy (View Summary)

IObservable
- IObservableValue

Implemented by

ObservableValue

Index

Properties

changed isDisposed type

Methods

dispose get set

Properties

`Readonly`changed

changed: ISignal<IObservableValue, ObservableValue.IChangedArgs>

The changed signal.

`Readonly`isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly`type

type: "Value"

The type of this object.

Methods

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IObservable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

get

get(): undefined | PartialJSONValue
Get the current value, or undefined if it has not been set.

Returns undefined | PartialJSONValue
- Defined in packages/observables/src/modeldb.ts:54

set

set(value: PartialJSONValue): void
Set the value.
Parameters
- value: PartialJSONValue
Returns void
- Defined in packages/observables/src/modeldb.ts:59