Module: helpers

helpers

Source:

Members

<inner> is[type]

Determine whether a variable is of the type specified in the function name, eg isNumber

Types available are Null, Undefined, Object, Array, String, Number, Boolean, Function, RegExp, NaN and Infinite

Source:

Methods

<static> arrayPluck(arr, key) → {Array}

Get a list of values with a common key from an array of objects

Parameters:
Name Type Description
arr Array

The array of objects to search

key String

The key of the object to get

Source:
Returns:
Type
Array

<static> isScalar(obj) → {bool}

Determine whether an object is scalar

Parameters:
Name Type Description
obj mixed
Source:
Returns:
Type
bool

<static> regexInArray(arr, pattern) → {Boolean}

Determine if a value matching the passed regular expression is in the passed array

Parameters:
Name Type Description
arr Array

The array to search

pattern RegExp

The pattern to match

Source:
Returns:
  • If an array item matches the pattern
Type
Boolean

<static> stringTrim(str) → {String}

Wrap String.prototype.trim in a way that is easily mappable

Parameters:
Name Type Description
str String

The string to trim

Source:
Returns:
  • The trimmed string
Type
String

<static> type(o) → {String}

Get the type of the variable passed

Parameters:
Name Type Description
o mixed
Source:
See:
Returns:
Type
String
DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects.
Documentation generated by JSDoc 3.3.0-beta1 on Wed Jan 28th 2015 using the DocStrap template.