## actions.collection Actions for management of *Collection* segment of Redux store. * [actions.collection](#module_actions.collection) * [.addItems(index)](#module_actions.collection.addItems) ⇒ Action * [.bookItems(ids, factor)](#module_actions.collection.bookItems) ⇒ Action * [.clean(timestamp)](#module_actions.collection.clean) ⇒ Action * [.freeItems(ids, factor)](#module_actions.collection.freeItems) ⇒ Action * [.loadItemInit(operationId, itemId)](#module_actions.collection.loadItemInit) ⇒ Action * [.loadItemDone(operationId, itemId, item)](#module_actions.collection.loadItemDone) ⇒ Action ### actions.collection.addItems(index) ⇒ Action Creates an action that adds items to the collection. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Description | | --- | --- | --- | | index | Object | The index of items to add. It is a JS object with ID-to-item mapping. Each item will be added to the collection under the specified index. | ### actions.collection.bookItems(ids, factor) ⇒ Action Creates an action that increments reference counters of the specified items. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Default | Description | | --- | --- | --- | --- | | ids | String \| Array.<String> | | Item ID, or an array of IDs. | | factor | Number | 1 | Optional. The increment value. | ### actions.collection.clean(timestamp) ⇒ Action Creates an action that removes from the collection all items that (i) are not used (i.e. their reference counters equal to zero); (ii) were added to the collection before the specified `timestamp`. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Default | Description | | --- | --- | --- | --- | | timestamp | Number | Number.MAX_VALUE | The minimal timestamp value of items that should be kept in the collection even if they are not currently used. | ### actions.collection.freeItems(ids, factor) ⇒ Action Creates an action that decrements reference counters of the specified collection items. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Default | Description | | --- | --- | --- | --- | | ids | String \| Array.<String> | | Item ID, or an array of IDs. | | factor | Number | 1 | Optional. Decrement value. | ### actions.collection.loadItemInit(operationId, itemId) ⇒ Action Creates an action that signals beginning of an async loading of the specified item. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Description | | --- | --- | --- | | operationId | String | Operation UUID, to match with the corresponding [loadItemDone](#module_actions.collection.loadItemDone) action. | | itemId | String | Item ID. | ### actions.collection.loadItemDone(operationId, itemId, item) ⇒ Action Creates an action that finalizes an async loading of the specified item. **Kind**: static method of [actions.collection](#module_actions.collection) | Param | Type | Description | | --- | --- | --- | | operationId | String | Operation UUID, to match with the corresponding [loadItemDone](#module_actions.collection.loadItemDone) action. | | itemId | String | Item ID. | | item | Any | The loaded item, to be added into the collection. |