# MapCollection

# Members

# collection

Source code (opens new window)

mapCollection.collection : Map<string, IndexMap>

Collection of index maps.

# Methods

# get

Source code (opens new window)

mapCollection.get([name]) ⇒ Array | IndexMap

Get index map for the provided name.

Param Type Description
[name] string optional Name of the index map.

# getLength

Source code (opens new window)

mapCollection.getLength() ⇒ number

Get collection size.

# initEvery

Source code (opens new window)

mapCollection.initEvery(length)

Set default values to index maps within collection.

Param Type Description
length number Destination length for all stored maps.

# register

Source code (opens new window)

mapCollection.register(uniqueName, indexMap)

Register custom index map.

Param Type Description
uniqueName string Unique name of the index map.
indexMap IndexMap Index map containing miscellaneous (i.e. Meta data, indexes sequence), updated after remove and insert data actions.

# unregister

Source code (opens new window)

mapCollection.unregister(name)

Unregister custom index map.

Param Type Description
name string Name of the index map.

# unregisterAll

Source code (opens new window)

mapCollection.unregisterAll()

Unregisters and destroys all collected index map instances.

Last Updated: Oct 26, 2021