API Docs for: 1.0.1

Grape.Bag Class

Extends
Defined in: js\grape\collections\bag.js:2

A bag class, ie. an unordered list. It is an array, but if you remove an item, and the bag contains at least one more item, the last item replaces the item, and length is reduced by 1.

Constructor

Grape.Bag

()

Defined in js\grape\collections\bag.js:2

Item Index

Methods

Methods

add

(
  • item
)
Number

Defined in js\grape\collections\bag.js:11

Adds an element to the bag. Equivalent to push()

Parameters:

  • item

    The item to add

Returns:

Number:

the new size of the bag

remove

(
  • index
)

Defined in js\grape\collections\bag.js:18

Parameters:

  • index Number

    The index to remove at

Returns:

:

The moved item (which replaces the removed item)