JSDoc: Class: Array

new Array()

Source:

ext/array.js, line 3

Methods

(static) from(object, mapFunctionopt, thatopt) → {Array}

Parameters:

Name	Type	Attributes	Description
`object`	Object		Array-like object
`mapFunction`	function	<optional>	(this = that, value, key)
`that`	*	<optional>

Source:

ext/array.js, line 57

Returns:

Type: Array

(static) is(value) → {Boolean}

Determines whether the given value is an array.

Parameters:

Name	Type	Description
`value`	*

Source:

ext/array.js, line 27

Returns:

Type: Boolean

(static) isArray(value) → {Boolean}

Alias for Array.is

Parameters:

Name	Type	Description
`value`	*

Source:

ext/array.js, line 19

Returns:

Type: Boolean

add(items) → {this}

Adds items to the array.

Parameters:

Name	Type	Description
`items`	Array

Source:

ext/array.js, line 81

Returns:

Type: this

each(callback, fromIndexopt, toIndexopt) → {this}

Executes the given function for every item in the array.

Parameters:

Name	Type	Attributes	Description
`callback`	function		(this = this, value, index, array = this)
`fromIndex`	Number	<optional>	inclusive
`toIndex`	Number	<optional>	exclusive

Source:

ext/array.js, line 166

Returns:

Type: this

every(callback, thatopt) → {Boolean}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 271

Returns:

Type: Boolean

filter(callback, thatopt) → {Array}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 254

Returns:

Type: Array

find(callback, thatopt) → {*}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 353

Returns:

Type: *

findIndex(callback, thatopt) → {Number}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 370

Returns:

Type: Number

first() → {*}

Source:

ext/array.js, line 146

Returns:

Type: *

forEach(callback, thatopt)

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 241

indexOf(value, fromopt) → {Number}

Parameters:

Name	Type	Attributes	Description
`value`	*
`from`	Number	<optional>

Source:

ext/array.js, line 186

Returns:

Type: Number

insert(index, items) → {this}

Inserts the given items in the array at the given index.

Parameters:

Name	Type	Description
`index`	Number
`items`	Array

Source:

ext/array.js, line 136

Returns:

Type: this

last() → {*}

Source:

ext/array.js, line 154

Returns:

Type: *

lastIndexOf(value, fromopt) → {Number}

Parameters:

Name	Type	Attributes	Description
`value`	*
`from`	Number	<optional>

Source:

ext/array.js, line 205

Returns:

Type: Number

map(callback, thatopt) → {Array}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 303

Returns:

Type: Array

reduce(callback, currentopt) → {Array}

Parameters:

Name	Type	Attributes	Default	Description
`callback`	Array.ReduceCallback
`current`	*	<optional>	this.first()

Source:

ext/array.js, line 318

Returns:

Type: Array

reduceRight(callback, currentopt) → {Array}

Parameters:

Name	Type	Attributes	Default	Description
`callback`	Array.ReduceCallback
`current`	*	<optional>	this.last()

Source:

ext/array.js, line 335

Returns:

Type: Array

remove(item) → {this}

Removes the item (if it is in the array) from the array.

Parameters:

Name	Type	Description
`item`	*

Source:

ext/array.js, line 105

Returns:

Type: this

removeAt(indexopt, amountopt) → {this}

Removes an item at the given index from the array.

Parameters:

Name	Type	Attributes	Default	Description
`index`	Number	<optional>	0
`amount`	Number	<optional>	1

Source:

ext/array.js, line 121

Returns:

Type: this

some(callback, thatopt) → {Boolean}

Parameters:

Name	Type	Attributes	Description
`callback`	Array.Callback
`that`	*	<optional>

Source:

ext/array.js, line 287

Returns:

Type: Boolean

tack(…items) → {this}

Similar to Array#add, but accepts items as arguments.

Parameters:

Name	Type	Attributes	Description
`items`	*	<repeatable>

Source:

ext/array.js, line 93

Returns:

Type: this

Type Definitions

Callback(value, index, array) → {undefined|Boolean|*}

This:

that

Parameters:

Name	Type	Description
`value`	*
`index`	Number
`array`	Array

Source:

ext/array.js, line 218

Returns:

Type: undefined | Boolean | *

ReduceCallback(current, value, index, array) → {*}

Parameters:

Name	Type	Description
`current`	*
`value`	*
`index`	Number
`array`	Array

Source:

ext/array.js, line 226

Returns:

Passed as the next `current`.

Type: *