ItemRegistry

Registry for item definitions.

Constructor

new ItemRegistry(itemsopt)

Parameters:
NameTypeAttributesDescription
itemsArray.<Object> | Object<optional>

Initial item definitions.

Classes

ItemRegistry

Members

_items :Map.<string, Object>

Type:
  • Map.<string, Object>

Methods

clear()

Clear all registered items.

get(id) → {Object|null}

Retrieve an item definition by id.

Parameters:
NameTypeDescription
idstring
Returns:
Type: 
Object | null

getAll() → {Array.<Object>}

Get all registered items.

Returns:
Type: 
Array.<Object>

getItem(id) → {Object|null}

Alias for get.

Parameters:
NameTypeDescription
idstring
Returns:
Type: 
Object | null

has(id) → {boolean}

Check if an item id exists.

Parameters:
NameTypeDescription
idstring
Returns:
Type: 
boolean

hasItem(id) → {boolean}

Alias for has.

Parameters:
NameTypeDescription
idstring
Returns:
Type: 
boolean

register(itemDef) → {Object}

Register an item definition.

Parameters:
NameTypeDescription
itemDefObject

Item definition object.

Returns:

Registered immutable item definition.

Type: 
Object

registerItem(itemDef) → {Object}

Alias for register.

Parameters:
NameTypeDescription
itemDefObject
Returns:
Type: 
Object

unregister(id) → {boolean}

Unregister an item by id.

Parameters:
NameTypeDescription
idstring
Returns:
Type: 
boolean