Options
All
  • Public
  • Public/Protected
  • All
Menu

Module IObservableMap<T>

The interfaces associated with an IObservableMap.

Type parameters

  • T

Hierarchy

Implemented by

Index

Interfaces

Type aliases

Properties

Methods

Type aliases

ChangeType

ChangeType: "add" | "remove" | "change"

The change types which occur on an observable map.

Properties

changed

changed: ISignal<this, IChangedArgs<T>>

A signal emitted when the map has changed.

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

size

size: number

The number of key-value pairs in the map.

type

type: "Map"

The type of the Observable.

Methods

clear

  • clear(): void

delete

  • delete(key: string): T | undefined

  • Remove a key from the map

    Parameters

    • key: string

      the key to remove.

    Returns T | undefined

    the value of the given key, or undefined if that does not exist.

dispose

  • dispose(): void

  • Dispose of the resources held by the map.

    Returns void

get

  • get(key: string): T | undefined

  • Get a value for a given key.

    Parameters

    • key: string

      the key.

    Returns T | undefined

    the value for that key.

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.

keys

  • keys(): string[]

  • Get a list of the keys in the map.

    Returns string[]

    • a list of keys.

set

  • set(key: string, value: T): T | undefined

  • Set a key-value pair in the map

    Parameters

    • key: string

      The key to set.

    • value: T

      The value for the key.

    Returns T | undefined

    the old value for the key, or undefined if that did not exist.

values

  • values(): T[]

  • Get a list of the values in the map.

    Returns T[]

    • a list of values.

Generated using TypeDoc