Alias for the avg() method.
The avg method returns the average of all items in the collection.
The chunk method breaks the collection into multiple, smaller collections of a given size.
The collapse method collapses a collection of arrays into a single, flat collection.
The combine method combines the keys of the collection with the values of another array or collection.
The concat method is used to merge two or more collections/arrays/objects.
The contains method determines whether the collection contains a given item.
The count method returns the total number of items in the collection.
The crossJoin method cross joins the collection with the given array or collection, returning all possible permutations.
The dd method will console.log the collection and exit the current process.
The diff method compares the collection against another collection or a plain array based on its values. This method will return the values in the original collection that are not present in the given collection.
The diffAssoc method compares the collection against another collection or a plain object based on its keys and values. This method will return the key / value pairs in the original collection that are not present in the given collection:
The diffKeys method compares the collection against another collection or a plain object based on its keys. This method will return the key / value pairs in the original collection that are not present in the given collection.
The dump method outputs the results at that moment and then continues processing.
The each method iterates over the items in the collection and passes each item to a callback.
The every method may be used to verify that all elements of a collection pass a given truth test.
The except method returns all items in the collection except for those with the specified keys.
The filter method filters the collection using the given callback, keeping only those items that pass a given truth test.
The first method returns the first element in the collection that passes a given truth test.
The flatMap method iterates through the collection and passes each value to the given callback. The callback is free to modify the item and return it, thus forming a new collection of modified items. Then, the array is flattened by a level.
The flatten method flattens a multi-dimensional collection into a single dimension.
The flip method swaps the collection's keys with their corresponding values.
The forPage method returns a new collection containing the items that would be present on a given page number. The method accepts the page number as its first argument and the number of items to show per page as its second argument.
The forget method removes an item from the collection by its key.
The get method returns the item at a given key. If the key does not exist, null is returned.
The groupBy method groups the collection's items by a given key.
The has method determines if one or more keys exists in the collection.
The implode method joins the items in a collection. Its arguments depend on the type of items in the collection.
If the collection contains arrays or objects, you should pass the key of the attributes you wish to join, and the "glue" string you wish to place between the values.
The intersect method removes any values from the original collection that are not present in the given array or collection. The resulting collection will preserve the original collection's keys.
The intersectByKeys method removes any keys from the original collection that are not present in the given array or collection.
The isEmpty method returns true if the collection is empty; otherwise, false is returned.
The isNotEmpty method returns true if the collection is not empty; otherwise, false is returned.
The keyBy method keys the collection by the given key. If multiple items have the same key, only the last one will appear in the new collection.
The keys method returns all of the collection's keys.
The last method returns the last element in the collection that passes a given truth test.
The macro method lets you register custom methods.
The map method iterates through the collection and passes each value to the given callback. The callback is free to modify the item and return it, thus forming a new collection of modified items.
The mapInto method iterates through the collection and instantiates the given class with each element as a constructor.
The mapToGroups method iterates through the collection and passes each value to the given callback.
The mapWithKeys method iterates through the collection and passes each value to the given callback. The callback should return an array where the first element represents the key and the second element represents the value pair.
The max method returns the maximum value of a given key.
The median method returns the median value of a given key.
The merge method merges the given object into the original collection. If a key in the given object matches a key in the original collection, the given objects value will overwrite the value in the original collection.
The min method returns the minimum value of a given key.
The mode method returns the mode value of a given key.
The nth method creates a new collection consisting of every n-th element.
The only method returns the items in the collection with the specified keys.
The partition method may be combined with destructuring to separate elements that pass a given truth test from those that do not.
The pipe method passes the collection to the given callback and returns the result.
The pluck method retrieves all of the values for a given key.
The pop method removes and returns the last item from the collection.
The prepend method adds an item to the beginning of the collection.
The pull method removes and returns an item from the collection by its key.
The push method appends an item to the end of the collection.
The put method sets the given key and value in the collection.
The random method returns a random item from the collection.
The reduce method reduces the collection to a single value, passing the result of each iteration into the subsequent iteration.
The reject method filters the collection using the given callback. The callback should return true if the item should be removed from the resulting collection.
The reverse method reverses the order of the collection's items.
The search method searches the collection for the given value and returns its key if found. If the item is not found, false is returned.
The shift method removes and returns the first item from the collection.
The shuffle method randomly shuffles the items in the collection.
The slice method returns a slice of the collection starting at the given index.
The sort method sorts the collection.
The sortBy method sorts the collection by the given key. The sorted collection keeps the original array keys.
The sortBy method sorts the collection by the given callback. The sorted collection keeps the original array keys.
This method has the same signature as the sortBy method, but will sort the collection in the opposite order.
This method has the same signature as the sortBy method, but will sort the collection in the opposite order.
The splice method removes and returns a slice of items starting at the specified index. You may pass a second argument to limit the size of the resulting chunk.
The split method breaks a collection into the given number of groups.
The sum method returns the sum of all items in the collection.
The take method returns a new collection with the specified number of items: You may also pass a negative integer to take the specified amount of items from the end of the collection.
The tap method passes the collection to the given callback, allowing you to "tap" into the collection at a specific point and do something with the items while not affecting the collection itself.
The times method creates a new collection by invoking the callback a given amount of times.
The toArray method converts the collection into a plain array. If the collection is an object, an array containing the values will be returned.
The toJson method converts the collection into JSON string.
The transform method iterates over the collection and calls the given callback with each item in the collection. The items in the collection will be replaced by the values returned by the callback.
The union method adds the given array to the collection. If the given array contains keys that are already in the original collection, the original collection's values will be preferred.
The unique method returns all of the unique items in the collection.
The unless method will execute the given callback when the first argument given to the method evaluates to false.
The unwrap method will unwrap the given collection.
The values method returns a new collection with the keys reset to consecutive integers.
The when method will execute the given callback when the first argument given to the method evaluates to true.
The where method filters the collection by a given key / value pair.
The where method filters the collection by a given key / value pair.
The whereIn method filters the collection by a given key / value contained within the given array.
The whereNotIn method filters the collection by a given key / value not contained within the given array.
The wrap method will wrap the given value in a collection.
The zip method merges together the values of the given array with the values of the original collection at the corresponding index.
The all method returns the underlying array represented by the collection.