arr

arr

Simple JavaScript utilities for working with arrays.

Install

Install with npm:

npm i arr --save-dev

Usage

var utils = require('arr');

API

filterType

Filter array, returning only the values of the given type.

• array {Array}
• type {String}: Native type, e.g. string, object
• returns: {Boolean}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];

utils.filterType(arr, 'object');
//=> [{a: 'b'}, {c: 'd'}]

numbers

• array {Array}
• index {Array}: Optionally specify the index of the number to return, otherwise all numbers are returned.
• returns: {Array}

Filter array, returning only the numbers.

strings

• array {Array}
• index {Array}: Optionally specify the index of the string to return, otherwise all strings are returned.
• returns: {Array}

Filter array, returning only the strings.

objects

• array {Array}
• index {Array}: Optionally specify the index of the object to return, otherwise all objects are returned.
• returns: {Array}

Filter array, returning only the objects.

functions

• array {Array}
• index {Array}: Optionally specify the index of the function to return, otherwise all functions are returned.
• returns: {Array}

Filter array, returning only the functions.

arrays

• array {Array}
• index {Array}: Optionally specify the index of the array to return, otherwise all arrays are returned.
• returns: {Array}

Filter array, returning only the arrays.

first

• array {Array}
• returns: {*}

Get the first element in array. Included for completeness.

last

• array {Array}
• returns: {*}

Get the last element in array.

lastOf

Get the last element in array of the given type.

• array {Array}
• type {String}: The native type to get.
• returns: {*}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
lastOf(arr, 'number');
//=> 2

firstOf

Get the first element in array of the given type.

• array {Array}
• type {String}: The native type to get.
• returns: {*}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
firstOf(arr, 'number');
//=> 1

lastIs

Returns true if the last element in array is the given type.

• array {Array}
• type {String}: The native type to check.
• returns: {Boolean}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
lastIs(arr, 'number');
//=> false

firstIs

Returns true if the first element in array is the given type.

• array {Array}
• type {String}: The native type to check.
• returns: {Boolean}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
firstIs(arr, 'string');
//=> true

firstStr

Get the first string in array.

• array {Array}
• returns: {String}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
firstStr(arr, 'string');
//=> 'a'

lastStr

Get the last string in array.

• array {Array}
• returns: {String}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
lastStr(arr, 'string');
//=> 'c'

firstFn

Get the first function in array.

• array {Array}
• returns: {Function}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
firstFn(arr, 'function');
//=> 'a'

lastFn

Get the last function in array.

• array {Array}
• returns: {Function}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
lastFn(arr, 'function');
//=> 'a'

firstObj

Get the first object in array.

• array {Array}
• returns: {Object}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
firstObj(arr);
//=> {a: 'b'}

lastObj

Get the last object in array.

• array {Array}
• returns: {Object}

var arr = ['a', {a: 'b'}, 1, 'b', 2, {c: 'd'}, 'c'];
lastObj(arr);
//=> {c: 'd'}

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

This file was generated by verb-cli on September 30, 2014.