Class InspectableArray

constructor

• new InspectableArray(elementType, parentProperty): InspectableArray

• Constructor for use by the runtime only.

  Parameters

  • elementType: Type

    TypeScript type of the elements in the array.
  • parentProperty: InspectableProperty

    Property used for retrieving this entry.

  Returns InspectableArray

ReadonlyparentProperty

elementPropertyType

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

• Type of serializable property used for the elements stored in the array.

  Returns EnumValue<InspectablePropertyType, number>

elementType

• get elementType(): Type

• Type used for the elements stored in the array.

  Returns Type

elementTypeArguments

• get elementTypeArguments(): Type[]

• Type arguments used for the elements stored in the array.

  Returns Type[]

addNewItem

• addNewItem(value): void

• Adds a new element to the end of the array.

  Parameters

  • value: any

    The value to be added at the end of the array.

  Returns void

createElementProperty

• createElementProperty(elementIndex): InspectableProperty

• Returns a serializable property for a specific array element.

  Parameters

  • elementIndex: number

    Index of the element in the array.

  Returns InspectableProperty

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

findProperty

• findProperty(pathElements, elementIndex): InspectableProperty

• Uses the provided path elements to find an array element at the specified index, 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 (array index is out of range, or property with that path doesn't exist).

getElement

• getElement(index): any

• Gets the value from the array at the specified index.

  Parameters

  • index: number

  Returns any

getLength

• getLength(): number

• Returns number of elements in the array.

  Returns number

  Number of elements in the array.

removeItemAtIndex

• removeItemAtIndex(index): void

• Removes the item at the given index.

  Parameters

  • index: number

    The index to remove the item at.

  Returns void

resize

• resize(newSize): void

• Resizes the array to the given newSize.

  Parameters

  • newSize: number

    The new size of the array. New items will be null and extra items will be discarded.

  Returns void

setElement

• setElement(index, value): void

• Assigns the value to the array at the specified index.

  Parameters

  • index: number
  • value: any

  Returns void

swapItemsAt

• swapItemsAt(index1, index2): void

• Swaps the items at index1 and index2.

  Parameters

  • index1: number
  • index2: number

  Returns void

StaticgetArrayItemAtIndex

• getArrayItemAtIndex<T>(array, index): T

• Gets the value from the array at the specified index.

  Type Parameters

  • T = any

  Parameters

  • array: T[]
  • index: number

  Returns T

StaticsetArrayItemAtIndex

• setArrayItemAtIndex<T>(array, index, value): void

• Assigns the value to the array at the specified index.

  Type Parameters

  • T = any

  Parameters

  • array: T[]
  • index: number
  • value: T

  Returns void