Prototype Storm - Supercharge your Javascript!

# average ≥ 0.1.0

Return the average of all the number elements.

Returns

Number

No options available.

[1, 2, 3].average() // 6

{a: 1, b: 2, c: 3}.average() // 6

Source Tests

# ellipsis ≥ 0.1.0

Cap a string by a max character length and an ellipsis character.

Returns

String

Type	Name	Default	Description
Integer	options.max	0	maximum of character until it should append an ellipsis
String	otpions.end	"..."	ellipsis character to display if the max character is reached

"hello world".ellipsis({ max: 5 }) // "hello.."

"hello universe".ellipsis({ max: 5, end: '!' }) // "hello!"

Source Tests

# empty ≥ 0.1.0

Returns true if the element is empty, else returns false.

Returns

Boolean

No options available.

{}.empty() // true

[].empty() // true

''.empty() // true

(0).empty() // true

new Regexp('').empty() // true

Source Tests

# flatten ≥ 0.1.0

Returns a one dimensional array containing all the values of the element.

Returns

Array

No options available.

{a: 1, b: 2, c: 3}.flatten() // [1, 2, 3]

[1, {a: 2, b: 3}].flatten() // [1, 2, 3]

Source Tests

# format ≥ 0.1.0

Return the formated element.

Returns

String

No options available.

"Hi {name}".format({ name: "John" }) // "Hi John"

Source Tests

# hasLetter ≥ 0.1.0

Returns true if the element contains letters.

Returns

Boolean

No options available.

'hello world'.hasLetters() // true

'42 - 7 = ??'.hasLetter() // false

Source Tests

# hasLowercase ≥ 0.1.0

Returns true if the element contains a lowercase.

Returns

Boolean

No options available.

'Hello'.hasLowercase() // true

'HELLO'.hasLowercase() // false

Source Tests

# hasMathSign ≥ 0.1.0

Returns true if the element contains mathematical signs.

Returns

Boolean

No options available.

'42 + 7'.hasMathSign() // true

'hello world'.hasMathSign() // false

Source Tests

# hasNumber ≥ 0.1.0

Returns true if the element has a number.

Returns

Boolean

No options available.

'42'.hasNumber() // true

'hello world'.hasNumber() // false

Source Tests

# hasUppercase ≥ 0.1.0

Returns true if the element contains an uppercase.

Returns

Boolean

No options available.

'Hello'.hasUppercase() // true

'hello'.hasUppercase() // false

Source Tests

# isArray ≥ 0.1.0

Return true if the element is an array.

Returns

Boolean

No options available.

new Date().isArray() // false

[].isArray() // true

Source Tests

# isBoolean ≥ 0.1.0

Returns true if the element is a boolean, else returns false.

Returns

Boolean

No options available.

(true).isBoolean() // true

(1).isBoolean() // false

Source Tests

# isDate ≥ 0.1.0

Returns true if the variable is a date, else returns false.

Returns

Boolean

No options available.

new Date('2018-01-01').isDate() // true

'2018-01-01'.isDate() // false

Source Tests

# isLowercase ≥ 0.1.0

Returns true if the string is only composed of lowercases.

Returns

Boolean

No options available.

'hello'.isLowercase() // true

'HELLO'.isLowercase() // false

Source Tests

# isNumber ≥ 0.1.0

Return true if the element is a number, else returns false.

Returns

Boolean

No options available.

Number(42).isNumber() // true

[42].isNumber() // false

Source Tests

# isObject ≥ 0.1.0

Returns true if the element is an object, else returns false.

Returns

Boolean

No options available.

{}.isObject() // true

[].isObject() // false

Source Tests

# isRegexp ≥ 0.1.0

Returns true if the element is a RegExp, else returns false.

Returns

Boolean

No options available.

/[a-z]/.isRegexp() // true

'/[a-z]/'.isRegexp() // false

Source Tests

# isString ≥ 0.1.0

Returns true if the element is a string, else returns false.

Returns

Boolean

No options available.

"hello".isString() // true

["hello"].isString() // false

Source Tests

# isUppercase ≥ 0.1.0

Returns true if the element is only composed of uppercases.

Returns

Boolean

No options available.

"HELLO".isUppercase() // true

"Hello".isUppercase() // false

Source Tests

# isValidDate ≥ 0.1.0

Returns true if the element is a valid date, else returns false.

Returns

Boolean

No options available.

'2018-01-01'.isValidDate() // true

new Date('2018-01-01').isValidDate() // true

'test'.isValidDate() // false

new Date('test').isValidDate() // false

Source Tests

# isValidNumber ≥ 0.1.0

Returns true if the number is valid, else returns false.

Returns

Boolean

No options available.

(42).isValidNumber() // true

Number('test').isValidNumber() // false

"test".isValidNumber() // false

Source Tests

# is ≥ 0.1.0

Check if the element is of the desired type.

Returns

Boolean

Type	Name	Default	Description
*	options.type		type to check the element on

([1, 2]).is({ type: Array }) // true

([1, 2]).is({ type: Boolean }) // false

Source Tests

# json ≥ 0.1.0

Returns the string representation of the variable turned into JSON

Returns

String

No options available.

{name: "John"}.json() // {"name": "John"}

Source Tests

# keys ≥ 0.1.0

Returns an array containing the keys of the element.

Returns

Array

No options available.

({a: 1, b: 2}).keys() // ['a', 'b']

({}).keys() // []

Source Tests

# last ≥ 0.1.0

Returns the last element of the variable

Returns

*

No options available.

[1, 2, 3].last() // 3

Source Tests

# log ≥ 0.1.0

Prompt to the console the element and returns the element.

Returns

*

No options available.

"hello".log()

[1, 2].log()

[1, 2].log().average() // chainable

Source Tests

# map ≥ 0.1.0

Execute a function for each key-pairs.

Returns

undefined

Type	Name	Default	Description
requestCallback	callback		function to apply for each key-pairs

{a: 1, b: 2, c: 3}.map(myFunction())

Source Tests

# nl2br ≥ 0.1.0

Turns any line return into HTML line return

Returns

*

Type	Name	Default	Description
Boolean	options.strict	false	when set to true, it will output strict HTML tag

"hello\r\nworld".nl2br() // "hello
world"

Source Tests

# only ≥ 0.1.0

Returns only the element you want from an array of keys.

Returns

*

Type	Name	Default	Description
Array	search		array of keys (or values for an array) to filter with

['js', 'php', 'node'].only(['js', 'node']) // ['js', 'node']

Source Tests

# parseCsv ≥ 0.1.0

Returns an array representing the CSV of the element.

Returns

Array

Type	Name	Default	Description
String	options.delimitedBy	','	character separating the cells
String	options.quotedBy	'"'	quote character in case a cell contains any delimitedBy character

"Name,Age\nJohn,25".parseCsv() // [['Name', 'Age'],['John', '25]]

Source Tests

# parseDate ≥ 0.1.0

Returns a new date from the element.

Returns

Date

No options available.

'2018-01-01'.parseDate() // new Date('2018-01-01)

Source Tests

# parseInt ≥ 0.1.0

Parse the element and returns its integer counterpart.

Returns

Integer

No options available.

"42".parseInt() // 42

Source Tests

# pass ≥ 0.1.0

Returns true if the element passes the regexp check.

Returns

Boolean

Type	Name	Default	Description
RegExp	options.regexp	/(?:)/	regular expression to test

"hello".pass(/[a-z]/g) // true

Number(34).pass(/^[3]/) // true

Source Tests

# queryStrings ≥ 0.1.0

Returns an object of the query string from the element.

Returns

Object

No options available.

'http://example.com/path/to/page?name=ferret&color=purple'.queryStrings() // { name: 'ferret', color: 'purple' }

Source Tests

# shuffle ≥ 0.1.0

Disorder the elements randomly.

Returns

*

No options available.

[1, 2, 3].shuffle() // [3, 1, 2]

"hello world".shuffle() // "lohel"

Source Tests

# sum ≥ 0.1.0

Returns the sum of the elements.

Returns

Number

No options available.

[1, 2, 3].sum() // 6

Source Tests

# toCamelCase ≥ 0.1.0

Return the camel case version of the element.

Returns

String

No options available.

'hello world'.toCamelCase() // "helloWorld"

Source Tests

# toCsv ≥ 0.1.0

Returns the CSV string representation of the element.

Returns

String

Type	Name	Default	Description
String	options.delimitedBy	','	string delimiter between cells
String	options.quotedBy	'"'	character to add in case the delimitedBy is present in the cell

[['John', '25']].toCsv() // "John,25"

Source Tests

# toKebabCase ≥ 0.1.0

Returns the kebab-case version of the string.

Returns

String

No options available.

'hello world'.toKebabCase() // 'hello-world'

Source Tests

# toQueryStrings ≥ 0.1.0

Return a query string as a string from the element.

Returns

String

No options available.

({name: 'John', age: 21}).toQueryStrings() // name=John&age=21

Source Tests

# toSeparated ≥ 0.1.0

Separate the items relative to a separator and returns the separated string.

Returns

String

No options available.

['php', 'js', 'mysql'].toSeparated() // "php,js,mysql"

['php', 'js', 'mysql'].toSeparated({ separator: ', ' }) // "php, js, mysql"

['php', 'js', 'mysql'].toSeparated({ separator: ', ', finisher: ' and ' }) // "php, js and mysql"

Source Tests

# toSnakeCase ≥ 0.1.0

Returns the string in snake_case format.

Returns

String

No options available.

'hello world'.toSnakeCase() // "hello_world"

Source Tests

# toTimestamp ≥ 0.1.0

Return the timestamp from the element.

Returns

Integer

No options available.

new Date('2018-01-01T00:00:00+00:00').toTimestamp() // 1514764800

Source Tests

# type ≥ 0.1.0

Returns the type of the element.

Returns

*

No options available.

[1, 2].type() // Array

[1, 2].type({ toString: true }) // "array"

Source Tests

# update ≥ 0.1.0

Update the values of the elements according to an object.

Returns

*

No options available.

({a: 1, b: 2}).update({ a: 3 }) // {a: 3, b: 2}

[1, 2, 3].update({ 0: 4 }) // [4, 2, 3]

"hello".update({ 0: 'y' }) // "yello"

Source Tests

# values ≥ 0.1.0

Returns an array of the values of the element.

Returns

Array

No options available.

({a: 1, b: 2}).values() // [1, 2]

({}).values() // []

Source Tests