Class InspectableMap

constructor

• new InspectableMap(keyType, valueType, parentProperty): InspectableMap

• Constructor for use by the runtime only.

  Parameters

  • keyType: Type

    TypeScript type of the keys in the map.
  • valueType: Type

    TypeScript type of the values in the map.
  • parentProperty: InspectableProperty

    Property used for retrieving this entry.

  Returns InspectableMap

ReadonlyparentProperty

keyPropertyType

• get keyPropertyType(): EnumValue<InspectablePropertyType, number>

• Type of serializable property used for the keys stored in the map.

  Returns EnumValue<InspectablePropertyType, number>

keyType

• get keyType(): Type

• Type used for of keys stored in the map.

  Returns Type

valuePropertyType

• get valuePropertyType(): EnumValue<InspectablePropertyType, number>

• Type of serializable property used for the values stored in the map.

  Returns EnumValue<InspectablePropertyType, number>

valueType

• get valueType(): Type

• Type used for values stored in the map.

  Returns Type

findProperty

• findProperty(pathElements, elementIndex): InspectableProperty

• Uses the provided path elements to find an map element with the specified key, and returns a property to the element, or to a child property of that element.

  Parameters

  • pathElements: PropertyPathElement[]

    Path elements representing field names and keys to look for.
  • elementIndex: number

    Index in the pathElements array to start the search at.

  Returns InspectableProperty

  Property representing the final path element, or null if not found (key or property with that path doesn't exist).

getLength

• getLength(): number

• Returns the total number of elements in the map.

  Returns number

  Total number of elements in the map.

getProperty

• getProperty(key): KeyValuePair<InspectableProperty, InspectableProperty>

• Returns a serializable property for the specified entry.

  Parameters

  • key: any

    map key for the value to retrieve.

  Returns KeyValuePair<InspectableProperty, InspectableProperty>

  Serializable property that allows you to manipulate contents of the map entry.