Version 3.18.1
Show:

State Class

Module: attribute

The State class maintains state for a collection of named items, with a varying number of properties defined.

It avoids the need to create a separate class for the item, and separate instances of these classes for each item, by storing the state in a 2 level hash table, improving performance when the number of items is likely to be large.

Constructor

State

()

Item Index

Properties

Methods

add

(
  • name
  • key
  • val
)

Adds a property to an item.

Parameters:

  • name String

    The name of the item.

  • key String

    The name of the property.

  • val Any

    The value of the property.

addAll

(
  • name
  • obj
)

Adds multiple properties to an item.

Parameters:

  • name String

    The name of the item.

  • obj Object

    A hash of property/value pairs.

get

(
  • name
  • key
)
Any

For a given item, returns the value of the property requested, or undefined if not found.

Parameters:

  • name String

    The name of the item

  • key String

    Optional. The property value to retrieve.

Returns:

Any:

The value of the supplied property.

getAll

(
  • name
  • reference
)
Object

For the given item, returns an object with all of the item's property/value pairs. By default the object returned is a shallow copy of the stored data, but passing in true as the second parameter will return a reference to the stored data.

Parameters:

  • name String

    The name of the item

  • reference Boolean

    true, if you want a reference to the stored object

Returns:

Object:

An object with property/value pairs for the item.

remove

(
  • name
  • key
)

Removes a property from an item.

Parameters:

  • name String

    The name of the item.

  • key String

    The property to remove.

removeAll

(
  • name
  • obj
)

Removes multiple properties from an item, or removes the item completely.

Parameters:

  • name String

    The name of the item.

  • obj Object | Array

    Collection of properties to delete. If not provided, the entire item is removed.

Properties

data

Unknown

Hash of attributes