crio Global

Members

<constant> ARRAY_FALLBACK_PROTOTYPE_METHODS :Object

Type:

Object

Source:

constants.js, line 23

<constant> ARRAY_UNSCOPABLES :Object

Type:

Object

Source:

constants.js, line 8

<constant> ARRAY_UNSCOPABLES :Object

Type:

Object

Source:

constants.js, line 98

<constant> REACT_ELEMENT_TYPE :Symbol|number

Type:

Symbol | number

Source:

constants.js, line 115

Methods

copyWithin(targetIndex [, startIndex] [, endIndex])

move values around within the array

Parameters:

Name	Type	Argument	Default	Description
`targetIndex`	number			target to copy
`startIndex`	number	<optional>	0	index to start copying to
`endIndex`	number	<optional>	this.length	index to stop copying to

Source:

CrioArray.js, line 138

Returns:

array with target copied in appropriate spots

Type: CrioArray

createIterator()

create a new iterator method

Source:

utils.js, line 24

Returns:

the iterator method

Type: function

every(object, fn)

does every result from calling fn match

Parameters:

Name	Type	Description
`object`	CrioArray \| CrioObject	the object to test
`fn`	function	the function to perform the test on each item with

Source:

utils.js, line 61

Returns:

does every item match

Type: boolean

every(fn)

does every instance in the array match

Parameters:

Name	Type	Description
`fn`	function	the function to test for matching

Source:

constants.js, line 28

Returns:

does every instance match

Type: boolean

fill(value [, startIndex] [, endIndex])

fill the array at certain indices with the value passed

Parameters:

Name	Type	Argument	Default	Description
`value`	*			the value to fill the indices with
`startIndex`	number	<optional>	0	the starting index to fill
`endIndex`	number	<optional>	this.length	the ending index to fill

Source:

CrioArray.js, line 272

Returns:

array with values filled appropriately

Type: CrioArray

find(object, fn [, isKey] [, isFromEnd])

find an item in the array if it exists

Parameters:

Name	Type	Argument	Description
`object`	CrioArray \| CrioObject		the object to search
`fn`	function		function to test for finding the item
`isKey`	boolean	<optional>	is the search for a key
`isFromEnd`	boolean	<optional>	is the search for a key

Source:

utils.js, line 87

Returns:

found item or undefined

Type: *

find(fn)

find an item in the array if it exists

Parameters:

Name	Type	Description
`fn`	function	function to test for finding the item

Source:

constants.js, line 42

Returns:

found item or undefined

Type: *

findIndex(fn)

find the index of an item in the array if it exists

Parameters:

Name	Type	Description
`fn`	function	function to test for finding the item

Source:

constants.js, line 56

Returns:

index of match, or -1

Type: number

getCrioedObject(object)

get the object converted to a CrioArray or CrioObject, if applicable

Parameters:

Name	Type	Description
`object`	*	the object to potentially crio

Source:

utils.js, line 119

Returns:

either the crioed object, or the object itself

Type: *

getEntries(object)

get the [key, value] pairs of the object

Parameters:

Name	Type	Description
`object`	CrioArray \| CrioObject	the object to get the entries of

Source:

utils.js, line 140

Returns:

the entries of the object

Type: CrioArray

getRelativeValue(value, length)

get the relative value used in copyWithin

Parameters:

Name	Type	Description
`value`	number	value used as baseline
`length`	number	the length of the crio

Source:

utils.js, line 155

Returns:

the relative number value

Type: number

getValues(object)

get the values of the object

Parameters:

Name	Type	Description
`object`	CrioArray \| CrioObject	the object to get the values of

Source:

utils.js, line 169

Returns:

the values of the object

Type: CrioArray

includes(item)

does the array have the item passed

Parameters:

Name	Type	Description
`item`	*	item to test for existence

Source:

constants.js, line 70

Returns:

does the item exist in the array

Type: boolean

isArray(object)

is the object passed an array

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 18

Returns:

is the object an array

Type: boolean

isCrio(object)

is the object passed a CrioArray or CrioObject

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 29

Returns:

is the object a Crio*

Type: boolean

isEqual(crio, object)

are the crio objects equal

Parameters:

Name	Type	Description
`crio`	CrioArray \| CrioObject	crio object to test against
`object`	*	object to test equality with crio object for

Source:

is.js, line 46

Returns:

are the objects equal

Type: boolean

isFunction(object)

is the object passed a function

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 60

Returns:

is the object a function

Type: boolean

isNumber(object)

is the object passed a number

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 73

Returns:

is the object a number

Type: boolean

isObject(object)

is the object passed a plain object

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 99

Returns:

is the object a plain object

Type: boolean

isReactElement(object)

is the object passed a react element

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 86

Returns:

is the object a react element

Type: boolean

isString(object)

is the object passed a string

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 112

Returns:

is the object a string

Type: boolean

isUndefined(object)

is the object passed undefined

Parameters:

Name	Type	Description
`object`	*	the object to test

Source:

is.js, line 125

Returns:

is the object undefined

Type: boolean

some(fn)

does any item in the array match the result from fn

Parameters:

Name	Type	Description
`fn`	function	the function to test for matching

Source:

constants.js, line 84

Returns:

does any item match

Type: boolean

some(object, fn)

does any result from calling fn match

Parameters:

Name	Type	Description
`object`	CrioArray \| CrioObject	the object to test
`fn`	function	the function to perform the test on each item with

Source:

utils.js, line 184

Returns:

does any item match

Type: boolean

thaw(object)

convert the CrioArray or CrioObject passed to a plain JS object

Parameters:

Name	Type	Description
`object`	CrioArray \| CrioObject	the object to convert

Source:

utils.js, line 210

Returns:

the plain JS version of the object passed

Type: Array | Object