Class ObservableJSON

A concrete Observable map for JSON data.

Hierarchy (View Summary)

ObservableMap<ReadonlyPartialJSONValue>
- ObservableJSON

Index

Constructors

constructor

new ObservableJSON(options?: ObservableJSON.IOptions): ObservableJSON
Construct a new observable JSON object.
Parameters
- options: ObservableJSON.IOptions = {}
Returns ObservableJSON
Overrides ObservableMap.constructor
- Defined in packages/observables/src/observablejson.ts:42

Accessors

changed

get changed(): ISignal<this, IObservableMap.IChangedArgs<T>>
A signal emitted when the map has changed.

Returns ISignal<this, IObservableMap.IChangedArgs<T>>
Inherited from ObservableMap.changed
- Defined in packages/observables/src/observablemap.ts:167

isDisposed

get isDisposed(): boolean
Whether this map has been disposed.

Returns boolean
Inherited from ObservableMap.isDisposed
- Defined in packages/observables/src/observablemap.ts:174

size

get size(): number
The number of key-value pairs in the map.

Returns number
Inherited from ObservableMap.size
- Defined in packages/observables/src/observablemap.ts:181

type

get type(): "Map"
The type of the Observable.

Returns "Map"
Inherited from ObservableMap.type
- Defined in packages/observables/src/observablemap.ts:160

Methods

clear

clear(): void
Set the ObservableMap to an empty map.

Returns void
Inherited from ObservableMap.clear
- Defined in packages/observables/src/observablemap.ts:296

delete

delete(key: string): undefined | ReadonlyPartialJSONValue
Remove a key from the map
Parameters
- key: string
  the key to remove.
Returns undefined | ReadonlyPartialJSONValue
the value of the given key, or undefined if that does not exist.

Notes
This is a no-op if the value does not change.
Inherited from ObservableMap.delete
- Defined in packages/observables/src/observablemap.ts:279

dispose

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

Returns void
Inherited from ObservableMap.dispose
- Defined in packages/observables/src/observablemap.ts:307

get

get(key: string): undefined | ReadonlyPartialJSONValue
Get a value for a given key.
Parameters
- key: string
  the key.
Returns undefined | ReadonlyPartialJSONValue
the value for that key.
Inherited from ObservableMap.get
- Defined in packages/observables/src/observablemap.ts:227

has

has(key: string): boolean
Check whether the map has a key.
Parameters
- key: string
  the key to check.
Returns boolean
true if the map has the key, false otherwise.
Inherited from ObservableMap.has
- Defined in packages/observables/src/observablemap.ts:238

keys

keys(): string[]
Get a list of the keys in the map.

Returns string[]
- a list of keys.
Inherited from ObservableMap.keys
- Defined in packages/observables/src/observablemap.ts:247

set

set(
key: string,
value: ReadonlyPartialJSONValue,
): undefined | ReadonlyPartialJSONValue
Set a key-value pair in the map
Parameters
- key: string
  The key to set.
- value: ReadonlyPartialJSONValue
  The value for the key.
Returns undefined | ReadonlyPartialJSONValue
the old value for the key, or undefined if that did not exist.

Throws
if the new value is undefined.

Notes
This is a no-op if the value does not change.
Inherited from ObservableMap.set
- Defined in packages/observables/src/observablemap.ts:200

toJSON

toJSON(): PartialJSONObject
Serialize the model to JSON.

Returns PartialJSONObject
- Defined in packages/observables/src/observablejson.ts:52

values

values(): ReadonlyPartialJSONValue[]
Get a list of the values in the map.

Returns ReadonlyPartialJSONValue[]
- a list of values.
Inherited from ObservableMap.values
- Defined in packages/observables/src/observablemap.ts:260

Class ObservableJSON

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ObservableJSON

Accessors

changed

Returns ISignal<this, IObservableMap.IChangedArgs<T>>

isDisposed

Returns boolean

size

Returns number

type

Returns "Map"

Methods

clear

Returns void

delete

Parameters

Returns undefined | ReadonlyPartialJSONValue

Notes

dispose

Returns void

get

Parameters

Returns undefined | ReadonlyPartialJSONValue

has

Parameters

Returns boolean

keys

Returns string[]

set

Parameters

Returns undefined | ReadonlyPartialJSONValue

Throws

Notes

toJSON

Returns PartialJSONObject

values

Returns ReadonlyPartialJSONValue[]

Settings

On This Page