Fix bin/publish: copy docs.dist from project root

Fix bin/publish: use correct .env path for rspade_system
Fix bin/publish script: prevent grep exit code 1 from terminating script

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
root
2025-10-21 02:08:33 +00:00
commit f6fac6c4bc
79758 changed files with 10547827 additions and 0 deletions

24
node_modules/collect.js/docs/api/all.md generated vendored Executable file
View File

@@ -0,0 +1,24 @@
# `all()`
The all method returns the underlying array or object represented by the collection:
```js
collect([1, 2, 3]).all();
// [1, 2, 3]
```
```js
collect({
firstname: 'Darwin',
lastname: 'Núñez',
}).all();
// {
// firstname: 'Darwin',
// lastname: 'Núñez',
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/all.js)

5
node_modules/collect.js/docs/api/average.md generated vendored Executable file
View File

@@ -0,0 +1,5 @@
# `average()`
Alias for the [`avg()`](#avg) method
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/average.js)

49
node_modules/collect.js/docs/api/avg.md generated vendored Executable file
View File

@@ -0,0 +1,49 @@
# `avg()`
The avg method returns the average of all items in the collection:
```js
collect([1, 3, 3, 7]).avg();
// 3.5
```
If the collection contains nested arrays or objects, you should pass a key to use for determining which values to calculate the average:
```js
const collection = collect([
{
name: 'My story',
pages: 176,
},
{
name: 'Fantastic Beasts and Where to Find Them',
pages: 1096,
},
]);
collection.avg('pages');
// 636
```
You may also define a callback function
```js
const collection = collect([
{
name: 'My story',
pages: 176,
},
{
name: 'Fantastic Beasts and Where to Find Them',
pages: 1096,
},
]);
collection.avg(book => book.pages);
// 636
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/avg.js)

15
node_modules/collect.js/docs/api/chunk.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `chunk()`
The chunk method breaks the collection into multiple, smaller collections of a given size:
```js
const collection = collect([1, 2, 3, 4, 5, 6, 7]);
const chunks = collection.chunk(4);
chunks.all();
// [[1, 2, 3, 4], [5, 6, 7]]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/chunk.js)

25
node_modules/collect.js/docs/api/collapse.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `collapse()`
The collapse method collapses a collection of arrays into a single, flat collection:
```js
const collection = collect([[1], [{}, 5, {}], ['xoxo']]);
const collapsed = collection.collapse();
collapsed.all();
// [1, {}, 5, {}, 'xoxo']
```
```js
const collection = collect([[1, 2, 3], [4, 5, 6], [7, 8, 9]]);
const collapsed = collection.collapse();
collapsed.all();
// [1, 2, 3, 4, 5, 6, 7, 8, 9]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/collapse.js)

18
node_modules/collect.js/docs/api/combine.md generated vendored Executable file
View File

@@ -0,0 +1,18 @@
# `combine()`
The combine method combines the keys of the collection with the values of another array or collection:
```js
const collection = collect(['name', 'number']);
const combine = collection.combine(['Mohamed Salah', 11]);
combine.all();
// {
// name: 'Mohamed Salah',
// number: 11
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/combine.js)

22
node_modules/collect.js/docs/api/concat.md generated vendored Executable file
View File

@@ -0,0 +1,22 @@
# `concat()`
The concat method is used to merge two or more collections/arrays/objects:
_You can also `concat()` an array of objects, or a multidimensional array_
```js
const collection = collect([1, 2, 3]);
let concatenated = collection.concat(['a', 'b', 'c']);
concatenated = concatenated.concat({
name: 'Mohamed Salah',
number: 11,
});
concatenated.all();
// [1, 2, 3, 'a', 'b', 'c', 'Mohamed Salah', 11]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/concat.js)

52
node_modules/collect.js/docs/api/contains.md generated vendored Executable file
View File

@@ -0,0 +1,52 @@
# `contains()`
The contains method determines whether the collection contains a given item:
```js
const collection = collect({
name: 'Mohamed Salah',
number: 11,
});
collection.contains('name');
// true
collection.contains('age');
// false
collection.contains('Mohamed Salah');
// true
```
You may also work with arrays
```js
const collection = collect([1, 2, 3]);
collection.contains(3);
// true
```
You may also pass a key / value pair to the contains method, which will determine if the given pair exists in the collection:
```js
const collection = collect({
name: 'Mohamed Salah',
number: 11,
});
collection.contains('name', 'Steve Jobs');
// false
```
Finally, you may also pass a callback to the contains method to perform your own truth test:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.contains((value, key) => value > 5);
// false
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/contains.js)

31
node_modules/collect.js/docs/api/containsOneItem.md generated vendored Executable file
View File

@@ -0,0 +1,31 @@
# `containsOneItem()`
The containsOneItem method returns true if the collection contains exactly one item; otherwise, false is returned:
```js
collect([1]).containsOneItem();
// true
collect({ firstname: 'Luis' }).containsOneItem();
// true
collect('value').containsOneItem();
// true
collect([1, 2, 3]).containsOneItem();
// false
collect({ firstname: 'Luis', lastname: 'Díaz' }).containsOneItem();
// false
collect().containsOneItem();
// false
collect([]).containsOneItem();
// false
collect({}).containsOneItem();
// false
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/containsOneItem.js)

13
node_modules/collect.js/docs/api/count.md generated vendored Executable file
View File

@@ -0,0 +1,13 @@
# `count()`
The count method returns the total number of items in the collection:
```js
const collection = collect([1, 2, 3, 4]);
collection.count();
// 4
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/count.js)

38
node_modules/collect.js/docs/api/countBy.md generated vendored Executable file
View File

@@ -0,0 +1,38 @@
# `countBy()`
The countBy method counts the occurences of values in the collection. By default, the method counts the occurrences of every element:
```js
const collection = collect([1, 2, 2, 2, 3]);
const counted = collection.countBy();
counted.all();
// {
// 1: 1,
// 2: 3,
// 3: 1,
// }
```
However, you pass a callback to the countBy method to count all items by a custom value:
```js
const collection = collect([
'mohamed.salah@gmail.com',
'darwin.nunez@yahoo.com',
'roberto.firmino@gmail.com',
]);
const counted = collection.countBy(email => email.split('@')[1]);
counted.all();
// {
// 'gmail.com': 2,
// 'yahoo.com': 1,
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/countBy.js)

20
node_modules/collect.js/docs/api/crossJoin.md generated vendored Executable file
View File

@@ -0,0 +1,20 @@
# `crossJoin()`
The crossJoin method cross joins the collection with the given array or collection, returning all possible permutations:
```js
const collection = collect([1, 2]);
const joined = collection.crossJoin(['a', 'b']);
joined.all();
// [
// [1, 'a'],
// [1, 'b'],
// [2, 'a'],
// [2, 'b'],
// ]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/crossJoin.js)

12
node_modules/collect.js/docs/api/dd.md generated vendored Executable file
View File

@@ -0,0 +1,12 @@
# `dd()`
The dd method will `console.log` the collection and exit the current process:
```js
const collection = collect([1, 2, 3]).dd();
// Collection { items: [ 1, 2, 3 ] }
// (Exits node.js process)
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/dd.js)

15
node_modules/collect.js/docs/api/diff.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `diff()`
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:
```js
const collection = collect([1, 2, 3, 4, 5]);
const diff = collection.diff([1, 2, 3, 9]);
diff.all();
// [4, 5]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/diff.js)

25
node_modules/collect.js/docs/api/diffAssoc.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `diffAssoc()`
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:
```js
const collection = collect({
color: 'orange',
type: 'fruit',
remain: 6,
});
const diff = collection.diffAssoc({
color: 'yellow',
type: 'fruit',
remain: 3,
used: 6,
});
diff.all();
// { color: 'orange', remain: 6 };
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/diffAssoc.js)

23
node_modules/collect.js/docs/api/diffKeys.md generated vendored Executable file
View File

@@ -0,0 +1,23 @@
# `diffKeys()`
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:
```js
const collection = collect({
a: 'a',
b: 'b',
c: 'c',
d: 'd',
});
const diff = collection.diffKeys({
b: 'b',
d: 'd',
});
diff.all();
// { a: 'a', c: 'c' }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/diffKeys.js)

25
node_modules/collect.js/docs/api/diffUsing.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `diffUsing()`
The diffUsing method compares the collection against another collection or a plain array based on its values using a callback. This method will return the values in the original collection that are not present in the given collection:
```js
const collection = collect([
{ name: 'Alice', age: 25 },
{ name: 'Bob', age: 30 },
{ name: 'Charlie', age: 35 },
]);
const users = [
{ name: 'Bob', age: 30 },
{ name: 'Charlie', age: 35 },
{ name: 'David', age: 40 },
];
const diff = collection.diffUsing(users, (a, b) => a.age - b.age);
diff.all();
// [{ name: 'Alice', age: 25 }]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/diffUsing.js)

47
node_modules/collect.js/docs/api/doesntContain.md generated vendored Executable file
View File

@@ -0,0 +1,47 @@
# `doesntContain()`
The `doesntContain` method determines whether the collection does not contain a given item. You may pass a closure to the `doesntContain` method to determine if an element does not exist in the collection matching a given truth test:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.doesntContain(value => value < 5);
// false
```
```js
const collection = collect([1, 2, 3]);
collection.doesntContain(4);
// true
```
You may also use `doesntContain` on object based collections:
```js
const collection = collect({
name: 'Mohamed Salah',
number: 11,
});
collection.doesntContain('Mohamed Salah');
// false
collection.doesntContain('Darwin Núñez');
// true
```
You may also pass a key / value pair to the contains method, which will determine if the given pair exists in the collection:
```js
const collection = collect({
name: 'Mohamed Salah',
number: 11,
});
collection.doesntContain('name', 'Darwin Núñez');
// true
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/doesntContain.js)

15
node_modules/collect.js/docs/api/dump.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `dump()`
The dump method outputs the results at that moment and then continues processing:
```js
collect([1, 2, 3, 4])
.dump()
.map(item => item * 2)
.dump();
// Collection { items: [ 1, 2, 3, 4 ] }
// Collection { items: [ 2, 4, 6, 8 ] }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/dump.js)

15
node_modules/collect.js/docs/api/duplicates.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `duplicates()`
The duplicates method retrieves and returns duplicate values from the collection:
```js
const collection = collect(['a', 'b', 'a', 'c', 'b']);
const duplicates = collection.duplicates();
duplicates.all();
// { 2: 'a', 4: 'b' }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/duplicates.js)

37
node_modules/collect.js/docs/api/each.md generated vendored Executable file
View File

@@ -0,0 +1,37 @@
# `each()`
The each method iterates over the items in the collection and passes each item to a callback:
```js
let sum = 0;
const collection = collect([1, 3, 3, 7]);
collection.each((item) => {
sum += item;
});
// console.log(sum);
// 14
```
If you would like to stop iterating through the items, you may return false from your callback:
```js
let sum = 0;
const collection = collect([1, 3, 3, 7]);
collection.each((item) => {
sum += item;
if (sum > 5) {
return false;
}
});
// console.log(sum);
// 7
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/each.js)

19
node_modules/collect.js/docs/api/eachSpread.md generated vendored Executable file
View File

@@ -0,0 +1,19 @@
# `eachSpread()`
The eachSpread method iterates over the collection's items, passing each nested item value into the given callback:
```js
const collection = collect([['John Doe', 35], ['Jane Doe', 33]]);
collection.eachSpread((name, age) => {
//
});
```
You may stop iterating through the items by returning false from the callback:
```js
collection.eachSpread((name, age) => false);
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/eachSpread.js)

11
node_modules/collect.js/docs/api/every.md generated vendored Executable file
View File

@@ -0,0 +1,11 @@
# `every()`
The every method may be used to verify that all elements of a collection pass a given truth test:
```js
collect([1, 2, 3, 4]).every((value, key) => value > 2);
// false
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/every.js)

29
node_modules/collect.js/docs/api/except.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `except()`
The except method returns all items in the collection except for those with the specified keys:
```js
const collection = collect({
product_id: 1,
price: 100,
discount: false,
});
const filtered = collection.except(['price', 'discount']);
filtered.all();
// { product_id: 1 }
```
```js
collect([1, 2, 3, 4])
.except([2, 12])
.all();
// [1, 3, 4]
```
> For the inverse of `except`, see the `only` method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/except.js)

45
node_modules/collect.js/docs/api/filter.md generated vendored Executable file
View File

@@ -0,0 +1,45 @@
# `filter()`
The filter method filters the collection using the given callback, keeping only those items that pass a given truth test:
```js
const collection = collect([1, 2, 3, 4]);
const filtered = collection.filter((value, key) => value > 2);
filtered.all();
// [3, 4]
```
If no callback is supplied, all entries of the collection that are equivalent to `false` will be removed:
```js
const collection = collect([
0,
1,
2,
null,
3,
4,
undefined,
5,
6,
7,
[],
8,
9,
{},
10,
]);
const filtered = collection.filter();
filtered.all();
// [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
```
> For the inverse of `filter`, see the `reject` method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/filter.js)

19
node_modules/collect.js/docs/api/first.md generated vendored Executable file
View File

@@ -0,0 +1,19 @@
# `first()`
The first method returns the first element in the collection that passes a given truth test:
```js
collect([1, 2, 3, 4]).first(item => item > 1);
// 2
```
You may also call the first method with no arguments to get the first element in the collection. If the collection is empty, null is returned:
```js
collect([1, 2, 3, 4]).first();
// 1
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/first.js)

46
node_modules/collect.js/docs/api/firstOrFail.md generated vendored Executable file
View File

@@ -0,0 +1,46 @@
# `firstOrFail()`
The firstOrFail method returns the first element in the collection, or throws an error if there are no elements:
```js
collect([1, 2, 3, 4]).firstOrFail(item => item > 1);
// 2
```
```js
collect([1, 2, 3, 4]).firstOrFail(item => item > 4);
// Error ('Item not found.') is thrown.
```
You may also call the firstOrFail method with no arguments to get the first element in the collection. If the collection is empty, an error is thrown:
```js
collect([1, 2, 3, 4]).firstOrFail();
// 1
```
```js
collect().firstOrFail();
// Error ('Item not found.') is thrown.
```
Like the where method, you may also pass an attribute, operator, and value:
```js
const collection = collect([
{ product: 'Desk', price: 200, discounted: true },
{ product: 'Chair', price: 100, discounted: true },
{ product: 'Bookcase', price: 150, discounted: true },
{ product: 'Door', price: 100 },
]);
collection.firstOrFail('product', '=', 'Desk');
// { product: 'Desk', price: 200, discounted: true }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/firstOrFail.js)

18
node_modules/collect.js/docs/api/firstWhere.md generated vendored Executable file
View File

@@ -0,0 +1,18 @@
# `firstWhere()`
The firstWhere method returns the first element in the collection with the given key / value pair:
```js
const collection = collect([
{ name: 'Regena', age: 12 },
{ name: 'Linda', age: 14 },
{ name: 'Diego', age: 23 },
{ name: 'Linda', age: 84 },
]);
collection.firstWhere('name', 'Linda');
// { name: 'Linda', age: 14 }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/firstWhere.js)

24
node_modules/collect.js/docs/api/flatMap.md generated vendored Executable file
View File

@@ -0,0 +1,24 @@
# `flatMap()`
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:
```js
const collection = collect([
{
name: 'Darwin Núñez',
number: 27,
},
{
name: 'Mohamed Salah',
number: 11,
},
]);
const flatMapped = collection.flatMap(value => value.name.toUpperCase());
flatMapped.all();
// ['DARWIN NÚÑEZ', 'MOHAMED SALAH']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/flatMap.js)

48
node_modules/collect.js/docs/api/flatten.md generated vendored Executable file
View File

@@ -0,0 +1,48 @@
# `flatten()`
The flatten method flattens a multi-dimensional collection into a single dimension:
```js
const collection = collect({
club: 'Liverpool',
players: ['Salah', 'Firmino', 'Núñez'],
});
const flattened = collection.flatten();
flattened.all();
// ['Liverpool', 'Salah', 'Firmino', 'Núñez'];
```
You may optionally pass the function a "depth" argument:
```js
const collection = collect({
Apple: [
{
name: 'iPhone 6S',
brand: 'Apple',
},
],
Samsung: [
{
name: 'Galaxy S7',
brand: 'Samsung',
},
],
});
const flattened = collection.flatten(1);
flattened.all();
// [
// { name: 'iPhone 6S', brand: 'Apple' },
// { name: 'Galaxy S7', brand: 'Samsung' },
// ]
```
In this example, calling flatten without providing the depth would have also flattened the nested arrays, resulting in `['iPhone 6S', 'Apple', 'Galaxy S7', 'Samsung']`. Providing a depth allows you to restrict the levels of nested arrays that will be flattened.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/flatten.js)

21
node_modules/collect.js/docs/api/flip.md generated vendored Executable file
View File

@@ -0,0 +1,21 @@
# `flip()`
The flip method swaps the collection's keys with their corresponding values:
```js
const collection = collect({
name: 'Darwin Núñez',
number: 27,
});
const flipped = collection.flip();
flipped.all();
// {
// 'Darwin Núñez': 'name',
// '27': 'number',
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/flip.js)

15
node_modules/collect.js/docs/api/forPage.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `forPage()`
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:
```js
const collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9]);
const forPage = collection.forPage(2, 3);
forPage.all();
// [4, 5, 6]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/forPage.js)

22
node_modules/collect.js/docs/api/forget.md generated vendored Executable file
View File

@@ -0,0 +1,22 @@
# `forget()`
The forget method removes an item from the collection by its key:
```js
const collection = collect({
name: 'Darwin Núñez',
number: 27,
});
collection.forget('number');
collection.all();
// {
// name: 'Darwin Núñez',
// }
```
> Unlike most other collection methods, forget does not return a new modified collection; it modifies the collection it is called on.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/forget.js)

53
node_modules/collect.js/docs/api/get.md generated vendored Executable file
View File

@@ -0,0 +1,53 @@
# `get()`
The get method returns the item at a given key or index. If the key or index does not exist, `null` is returned:
```js
const collection = collect({
firstname: 'Mohamed',
lastname: 'Salah',
});
collection.get('lastname');
// Salah
collection.get('middlename');
// null
```
```js
const collection = collect(['a', 'b', 'c']);
collection.get(1);
// b
```
You may optionally pass a default value as the second argument:
```js
const collection = collect({
firstname: 'Mohamed',
lastname: 'Salah',
});
collection.get('middlename', 'default-value');
// default-value
```
You may even pass a callback as the default value. The result of the callback will be returned if the specified key does not exist:
```js
const collection = collect({
firstname: 'Mohamed',
lastname: 'Salah',
});
collection.get('middlename', () => 'default-value');
// default-value
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/get.js)

109
node_modules/collect.js/docs/api/groupBy.md generated vendored Executable file
View File

@@ -0,0 +1,109 @@
# `groupBy()`
The groupBy method groups the collection's items into multiple collections by a given key:
> If you want to group the collection by keys as a plain object, see [mapToGroups](mapToGroups)
```js
const collection = collect([
{
product: 'Chair',
manufacturer: 'IKEA',
},
{
product: 'Desk',
manufacturer: 'IKEA',
},
{
product: 'Chair',
manufacturer: 'Herman Miller',
},
]);
const grouped = collection.groupBy('manufacturer');
grouped.all();
// {
// IKEA: Collection {
// items: [
// {
// id: 100,
// product: 'Chair',
// manufacturer: 'IKEA',
// price: '1490 NOK',
// },
// {
// id: 150,
// product: 'Desk',
// manufacturer: 'IKEA',
// price: '900 NOK',
// },
// ],
// },
// 'Herman Miller': Collection {
// items: [
// {
// id: 200,
// product: 'Chair',
// manufacturer: 'Herman Miller',
// price: '9990 NOK',
// },
// ],
// },
// }
```
In addition to passing a string key, you may also pass a callback. The callback should return the value you wish to key the group by:
```js
const collection = collect([
{
product: 'Chair',
manufacturer: 'IKEA',
},
{
product: 'Desk',
manufacturer: 'IKEA',
},
{
product: 'Chair',
manufacturer: 'Herman Miller',
},
]);
const grouped = collection.groupBy((item, key) => item.manufacturer.substring(0, 3));
grouped.all();
// {
// IKE: Collection {
// items: [
// {
// id: 100,
// product: 'Chair',
// manufacturer: 'IKEA',
// price: '1490 NOK',
// },
// {
// id: 150,
// product: 'Desk',
// manufacturer: 'IKEA',
// price: '900 NOK',
// },
// ],
// },
// Her: Collection {
// items: [
// {
// id: 200,
// product: 'Chair',
// manufacturer: 'Herman Miller',
// price: '9990 NOK',
// },
// ],
// },
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/groupBy.js)

24
node_modules/collect.js/docs/api/has.md generated vendored Executable file
View File

@@ -0,0 +1,24 @@
# `has()`
The has method determines if one or more keys exists in the collection:
```js
const collection = collect({
animal: 'unicorn',
ability: 'magical',
});
collection.has('ability');
// true
collection.has(['animal', 'ability']);
// true
collection.has(['animal', 'ability', 'name']);
// false
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/has.js)

34
node_modules/collect.js/docs/api/implode.md generated vendored Executable file
View File

@@ -0,0 +1,34 @@
# `implode()`
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:
```js
const collection = collect([
{
product: 'Chair',
manufacturer: 'IKEA',
},
{
product: 'Desk',
manufacturer: 'IKEA',
},
{
product: 'Chair',
manufacturer: 'Herman Miller',
},
]);
collection.implode('product', ',');
// Chair, Desk, Chair
```
If the collection contains simple strings or numeric values, simply pass the "glue" as the only argument to the method:
```js
collect([1, 2, 3, 4, 5]).implode('-');
// 1-2-3-4-5
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/implode.js)

15
node_modules/collect.js/docs/api/intersect.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `intersect()`
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:
```js
const collection = collect([1, 2, 3, 4, 5]);
intersect = collection.intersect([1, 2, 3, 9]);
intersect.all();
// [1, 2, 3]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/intersect.js)

34
node_modules/collect.js/docs/api/intersectByKeys.md generated vendored Executable file
View File

@@ -0,0 +1,34 @@
# `intersectByKeys()`
The intersectByKeys method removes any keys from the original collection that are not present in the given `array` or collection:
```js
const collection = collect({
serial: 'UX301',
type: 'screen',
year: 2009,
});
const intersect = collection.intersectByKeys({
reference: 'UX404',
type: 'tab',
year: 2011,
});
intersect.all();
// { type: 'screen', year: 2009 }
```
```js
const firstCollection = collect([1, 2, 3, 4, 5]);
const secondCollection = collect([1, 2, 3, 9]);
intersect = firstCollection.intersect(secondCollection);
intersect.all();
// [1, 2, 3]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/intersectByKeys.js)

16
node_modules/collect.js/docs/api/isEmpty.md generated vendored Executable file
View File

@@ -0,0 +1,16 @@
# `isEmpty()`
The isEmpty method returns true if the collection is empty; otherwise, false is returned:
```js
collect().isEmpty();
// true
collect([]).isEmpty();
// true
collect({}).isEmpty();
// true
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/isEmpty.js)

19
node_modules/collect.js/docs/api/isNotEmpty.md generated vendored Executable file
View File

@@ -0,0 +1,19 @@
# `isNotEmpty()`
The isNotEmpty method returns true if the collection is not empty; otherwise, false is returned:
```js
collect([1, 2, 3]).isNotEmpty();
// true
collect().isNotEmpty();
// false
collect([]).isNotEmpty();
// false
collect({}).isNotEmpty();
// false
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/isNotEmpty.js)

22
node_modules/collect.js/docs/api/join.md generated vendored Executable file
View File

@@ -0,0 +1,22 @@
# `join()`
The join method joins the collection's values with a string:
```js
collect(['a', 'b', 'c']).join(', ');
// 'a, b, c'
collect(['a', 'b', 'c']).join(', ', ', and ');
// 'a, b, and c'
collect(['a', 'b']).join(', ', ' and ');
// 'a and b'
collect(['a']).join(', ', ' and ');
// 'a'
collect([]).join(', ', ' and ');
// ''
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/join.js)

56
node_modules/collect.js/docs/api/keyBy.md generated vendored Executable file
View File

@@ -0,0 +1,56 @@
# `keyBy()`
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:
```js
const collection = collect([
{
product: 'Chair',
manufacturer: 'IKEA',
},
{
product: 'Desk',
manufacturer: 'IKEA',
},
{
product: 'Chair',
manufacturer: 'Herman Miller',
},
]);
const keyed = collection.keyBy('manufacturer');
keyed.all();
// {
// IKEA: {
// product: 'Desk',
// manufacturer: 'IKEA',
// },
// 'Herman Miller': {
// product: 'Chair',
// manufacturer: 'Herman Miller',
// },
// }
```
You may also pass a callback to the method. The callback should return the value to key the collection by:
```js
const upperCased = collection.keyBy(item => item.manufacturer.toUpperCase());
upperCased.all();
// {
// IKEA: {
// product: 'Desk',
// manufacturer: 'IKEA',
// },
// 'HERMAN MILLER': {
// product: 'Chair',
// manufacturer: 'Herman Miller',
// },
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/keyBy.js)

18
node_modules/collect.js/docs/api/keys.md generated vendored Executable file
View File

@@ -0,0 +1,18 @@
# `keys()`
The keys method returns all of the collection's keys:
```js
const collection = collect([
{
club: 'Liverpool',
nickname: 'The Reds',
},
]);
keys = collection.keys();
// ['club', 'nickname']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/keys.js)

21
node_modules/collect.js/docs/api/last.md generated vendored Executable file
View File

@@ -0,0 +1,21 @@
# `last()`
The last method returns the last element in the collection that passes a given truth test:
```js
const collection = collect([1, 2, 3]);
const last = collection.last(item => item > 1);
// 3
```
You may also call the last method with no arguments to get the last element in the collection. If the collection is empty, `null` is returned:
```js
collect([1, 2, 3, 4]).last();
// 4
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/last.js)

21
node_modules/collect.js/docs/api/macro.md generated vendored Executable file
View File

@@ -0,0 +1,21 @@
# `macro()`
The macro method lets you register custom methods
```js
collect().macro('uppercase', function () {
return this.map(item => item.toUpperCase());
});
const collection = collect(['a', 'b', 'c']);
collection.uppercase();
collection.all();
// ['A', 'B', 'C']
```
> Note that the `macro` method returns `undefined`, and therefore it is not possible to use it within a chain of methods.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/macro.js)

7
node_modules/collect.js/docs/api/make.md generated vendored Executable file
View File

@@ -0,0 +1,7 @@
# `make()`
The make method creates a new collection instance.
> This is only added to adhere to the Laravel collection API, when using Collect.js it's recommended to use `collect()` directly when creating a new collection.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/make.js)

17
node_modules/collect.js/docs/api/map.md generated vendored Executable file
View File

@@ -0,0 +1,17 @@
# `map()`
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:
```js
const collection = collect([1, 2, 3, 4, 5]);
const multiplied = collection.map(item => item * 2);
multiplied.all();
// [2, 4, 6, 8, 10]
```
> Like most other collection methods, `map` returns a new collection instance; it does not modify the collection it is called on. If you want to transform the original collection, use the `transform` method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/map.js)

25
node_modules/collect.js/docs/api/mapInto.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `mapInto()`
The mapInto method iterates through the collection and instantiates the given class with each element as a constructor:
```js
const Player = function (name) {
this.name = name;
};
const collection = collect([
'Roberto Firmino',
'Darwin Núñez',
]);
const players = collection.mapInto(Player);
players.all();
// [
// Player { name: 'Roberto Firmino' },
// Player { name: 'Darwin Núñez' },
// ]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mapInto.js)

18
node_modules/collect.js/docs/api/mapSpread.md generated vendored Executable file
View File

@@ -0,0 +1,18 @@
# `mapSpread()`
The mapSpread method iterates over the collection's items, passing each nested item value into the given callback.
The callback is free to modify the item and return it, thus forming a new collection of modified items:
```js
const collection = collect([0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);
const chunks = collection.chunk(2);
const sequence = chunks.mapSpread((even, odd) => even + odd);
sequence.all();
// [1, 5, 9, 13, 17]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mapSpread.js)

25
node_modules/collect.js/docs/api/mapToDictionary.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `mapToDictionary()`
Run a dictionary map over the items.
The callback should return an associative array with a single key/value pair.
```js
const collection = collect([
{ id: 1, name: 'a' },
{ id: 2, name: 'b' },
{ id: 3, name: 'c' },
{ id: 4, name: 'b' },
]);
const groups = collection.mapToDictionary(item => [item.name, item.id]);
groups.all();
// {
// a: [1],
// b: [2, 4],
// c: [3],
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mapToDictionary.js)

22
node_modules/collect.js/docs/api/mapToGroups.md generated vendored Executable file
View File

@@ -0,0 +1,22 @@
# `mapToGroups()`
The mapToGroups method iterates through the collection and passes each value to the given callback:
```js
const collection = collect([
{ id: 1, name: 'A' },
{ id: 2, name: 'B' },
{ id: 3, name: 'C' },
{ id: 4, name: 'B' },
]);
const groups = collection.mapToGroups((item, key) => [item.name, item.id]);
// {
// A: [1],
// B: [2, 4],
// C: [3],
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mapToGroups.js)

29
node_modules/collect.js/docs/api/mapWithKeys.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `mapWithKeys()`
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:
```js
const collection = collect([
{
name: 'John',
department: 'Sales',
email: 'john@example.com',
},
{
name: 'Jane',
department: 'Marketing',
email: 'jane@example.com',
},
]);
const keyed = collection.mapWithKeys(item => [item.email, item.name]);
keyed.all();
// {
// 'john@example.com': 'John',
// 'jane@example.com': 'Jane',
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mapWithKeys.js)

32
node_modules/collect.js/docs/api/max.md generated vendored Executable file
View File

@@ -0,0 +1,32 @@
# `max()`
The max method returns the maximum value of a given key:
```js
const collection = collect([
{
value: 10,
},
{
value: -13,
},
{
value: 12,
},
{
unicorn: false,
},
]);
const max = collection.max('value');
// 12
```
```js
collect([-1, -2345, 12, 11, 3]).max();
// 12
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/max.js)

30
node_modules/collect.js/docs/api/median.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `median()`
The median method returns the median value of a given key:
```js
collect([1, 3, 3, 6, 7, 8, 9]).median();
// 6
```
```js
collect([
{
foo: 1,
},
{
foo: 1,
},
{
foo: 2,
},
{
foo: 4,
},
]).median('foo');
// 1.5
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/median.js)

33
node_modules/collect.js/docs/api/merge.md generated vendored Executable file
View File

@@ -0,0 +1,33 @@
# `merge()`
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:
```js
const collection = collect({
id: 1,
price: 29,
});
const merged = collection.merge({
price: 400,
discount: false,
});
merged.all();
// { id: 1, price: 400, discount: false }
```
If our collection is an array, the values will be appended to the end of the collection:
```js
const collection = collect(['Unicorn', 'Rainbow']);
const merged = collection.merge(['Sunshine', 'Rainbow']);
merged.all();
// ['Unicorn', 'Rainbow', 'Sunshine', 'Rainbow']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/merge.js)

26
node_modules/collect.js/docs/api/mergeRecursive.md generated vendored Executable file
View File

@@ -0,0 +1,26 @@
# `mergeRecursive()`
The mergeRecursive method merges the given array or collection recursively with the original collection. If a string key in the given items matches a string key in the original collection, then the values for these keys are merged together into an array, and this is done recursively:
```js
const collection = collect({
product_id: 1,
price: 100,
});
const merged = collection.mergeRecursive({
product_id: 2,
price: 200,
discount: false,
});
merged.all();
// {
// product_id: [1, 2],
// price: [100, 200],
// discount: false,
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mergeRecursive.js)

29
node_modules/collect.js/docs/api/min.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `min()`
The min method returns the minimum value of a given key:
```js
const collection = collect([
{
worth: 100,
},
{
worth: 900,
},
{
worth: 79,
},
]);
collection.min('worth');
// 79
```
```js
collect([1, 2, 3, 4, 5]).min();
// 1
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/min.js)

30
node_modules/collect.js/docs/api/mode.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `mode()`
The mode method returns the mode value of a given key:
```js
collect([1, 3, 3, 6, 7, 8, 9]).mode();
// [3]
```
```js
collect([
{
foo: 1,
},
{
foo: 1,
},
{
foo: 2,
},
{
foo: 4,
},
]).mode('foo');
// [1]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/mode.js)

15
node_modules/collect.js/docs/api/nth.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `nth()`
The nth method creates a new collection consisting of every n-th element:
```js
const collection = collect(['a', 'b', 'c', 'd', 'e', 'f']);
const nth = collection.nth(4);
nth.all();
// ['a', 'e']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/nth.js)

30
node_modules/collect.js/docs/api/only.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `only()`
The only method returns the items in the collection with the specified keys:
```js
const collection = collect({
id: 12,
name: 'John Doe',
email: 'john@doe.com',
active: true,
});
const filtered = collection.only(['name', 'email']);
filtered.all();
// { name: 'John Doe', email: 'john@doe.com' }
```
```js
collect([1, 2, 3, 4])
.only([2, 12])
.all();
// [2]
```
> For the inverse of `only`, see the `except` method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/only.js)

24
node_modules/collect.js/docs/api/pad.md generated vendored Executable file
View File

@@ -0,0 +1,24 @@
# `pad()`
The pad method will fill the array with the given value until the array reaches the specified size. This method
behaves like the [array_pad](https://secure.php.net/manual/en/function.array-pad.php) PHP function.
To pad to the left, you should specify a negative size. No padding will take place if the absolute value of the given size is less than or equal to the length of the array:
```js
const collection = collect(['A', 'B', 'C']);
let filtered = collection.pad(5, 0);
filtered.all();
// ['A', 'B', 'C', 0, 0]
filtered = collection.pad(-5, 0);
filtered.all();
// [0, 0, 'A', 'B', 'C']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pad.js)

11
node_modules/collect.js/docs/api/partition.md generated vendored Executable file
View File

@@ -0,0 +1,11 @@
# `partition()`
The partition method may be combined with destructuring to separate elements that pass a given truth test from those that do not:
```js
const collection = collect([1, 2, 3, 4, 5, 6]);
const [underThree, overThree] = collection.partition(i => i < 3);
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/partition.js)

13
node_modules/collect.js/docs/api/pipe.md generated vendored Executable file
View File

@@ -0,0 +1,13 @@
# `pipe()`
The pipe method passes the collection to the given callback and returns the result:
```js
const collection = collect([1, 2, 3]);
const piped = collection.pipe(items => items.sum());
// 6
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pipe.js)

101
node_modules/collect.js/docs/api/pluck.md generated vendored Executable file
View File

@@ -0,0 +1,101 @@
# `pluck()`
The pluck method retrieves all of the values for a given key:
```js
const collection = collect([
{
id: 78,
name: 'Aeron',
},
{
id: 79,
name: 'Embody',
},
]);
const plucked = collection.pluck('name');
plucked.all();
// ['Aeron', 'Embody']
```
You may also specify how you wish the resulting collection to be keyed:
```js
const collection = collect([
{
id: 78,
name: 'Aeron',
},
{
id: 79,
name: 'Embody',
},
]);
const plucked = collection.pluck('name', 'id');
plucked.all();
// {
// 78: 'Aeron',
// 79: 'Embody',
// }
```
You can use "dot notation" to access nested values
```js
const collection = collect([
{
name: 'John',
roles: [
{
name: 'Editor',
},
{
name: 'Admin',
},
],
},
]);
const plucked = collection.pluck('roles.0.name');
plucked.all();
// ['Editor']
```
"Dot notation" supports "wildcard"
```js
const collection = collect([
{
name: 'John',
roles: [
{
name: 'Editor',
},
{
name: 'Admin',
},
],
},
]);
const plucked = collection.pluck('roles.*.name');
plucked.all();
// [
// [
// 'Editor',
// 'Admin',
// ],
// ]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pluck.js)

30
node_modules/collect.js/docs/api/pop.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `pop()`
The pop method removes and returns the last item from the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.pop();
// 5
collection.all();
// => [1, 2, 3, 4]
```
You may provide number of items to pop. This will return the popped items in a new collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.pop(2).all();
// [4, 5]
collection.all();
// => [1, 2, 3]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pop.js)

34
node_modules/collect.js/docs/api/prepend.md generated vendored Executable file
View File

@@ -0,0 +1,34 @@
# `prepend()`
The prepend method adds an item to the beginning of the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.prepend(0);
collection.all();
// [0, 1, 2, 3, 4, 5]
```
You may also pass a second argument to set the key of the prepended item:
> Pro tip: Order of properties in objects is not guaranteed in JavaScript; When calling prepend with a key, the Collection uses the underlying `put` method behind the scenes. This is only supported so that collect.js have the same api as Laravel Collections.
```js
const collection = collect({
product: 'iPhone 6s',
});
collection.prepend('Apple', 'brand');
collection.all();
// {
// brand: 'Apple',
// product: 'iPhone 6s',
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/prepend.js)

20
node_modules/collect.js/docs/api/pull.md generated vendored Executable file
View File

@@ -0,0 +1,20 @@
# `pull()`
The pull method removes and returns an item from the collection by its key:
```js
const collection = collect({
firstname: 'Michael',
lastname: 'Cera',
});
collection.pull('lastname');
// Cera
collection.all();
// { firstname: 'Michael' }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pull.js)

15
node_modules/collect.js/docs/api/push.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `push()`
The push method appends an item to the end of the collection:
```js
const collection = collect([1, 2, 3, 4]);
collection.push(5);
collection.all();
// [1, 2, 3, 4, 5]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/push.js)

15
node_modules/collect.js/docs/api/put.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `put()`
The put method sets the given key and value in the collection:
```js
const collection = collect(['JavaScript', 'Python']);
collection.put('Ruby');
collection.all();
// ['JavaScript', 'Python', 'Ruby']
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/put.js)

29
node_modules/collect.js/docs/api/random.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `random()`
The random method returns a random item from the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.random();
// 4 (retrieved randomly)
```
You may optionally pass an integer to random to specify how many items you would like to randomly retrieve. A collection of items is always returned when explicitly passing the number of items you wish to receive:
```js
const threeRandom = collection.random(3);
// Collection { items: [ 5, 3, 4 ] } (retrieved randomly)
const oneRandom = collection.random(1);
// Collection { items: [ 3 ] } (retrieved randomly)
oneRandom.all();
// [3]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/random.js)

21
node_modules/collect.js/docs/api/reduce.md generated vendored Executable file
View File

@@ -0,0 +1,21 @@
# `reduce()`
The reduce method reduces the collection to a single value, passing the result of each iteration into the subsequent iteration:
```js
const collection = collect([1, 2, 3]);
const total = collection.reduce((carry, item) => carry + item);
// 6
```
The value for `carry` on the first iteration is null; however, you may specify its initial value by passing a second argument to reduce:
```js
const total = collection.reduce((carry, item) => carry + item, 4);
// 10
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/reduce.js)

15
node_modules/collect.js/docs/api/reject.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `reject()`
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:
```js
const collection = collect([1, 2, 3, 4]);
const filtered = collection.reject(value => value > 2);
// [1, 2]
```
> For the inverse of the `reject` method, see the `filter` method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/reject.js)

23
node_modules/collect.js/docs/api/replace.md generated vendored Executable file
View File

@@ -0,0 +1,23 @@
# `replace()`
The replace method behaves similarly to merge; however, in addition to overwriting matching items with string keys, the replace method will also overwrite items in the collection that have matching numeric keys:
```js
const collection = collect({
name: 'Bob',
});
const replaced = collection.replace({
name: 'John',
number: 45,
});
replaced.all();
// {
// name: 'John',
// number: 45,
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/replace.js)

30
node_modules/collect.js/docs/api/replaceRecursive.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `replaceRecursive()`
This method works like replace, but it will recurse into arrays and apply the same replacement process to the inner values:
```js
const collection = collect([
'Matip',
'van Dijk',
[
'Núñez',
'Firmino',
'Salah',
],
]);
const replaced = collection.replaceRecursive({
0: 'Gomez',
2: { 1: 'Origi' },
});
replaced.all();
// {
// 0: 'Gomez',
// 1: 'van Dijk',
// 2: { 0: 'Núñez', 1: 'Origi', 2: 'Salah' },
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/replaceRecursive.js)

15
node_modules/collect.js/docs/api/reverse.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `reverse()`
The reverse method reverses the order of the collection's items:
```js
const collection = collect([1, 2, 3, 4, 5]);
const reversed = collection.reverse();
reversed.all();
// [5, 4, 3, 2, 1]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/reverse.js)

29
node_modules/collect.js/docs/api/search.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `search()`
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.
```js
const collection = collect([2, 4, 6, 8]);
collection.search(4);
// 1
```
The search is done using a "loose" comparison, meaning a string with an integer value will be considered equal to an integer of the same value. To use strict comparison, pass true as the second argument to the method:
```js
collection.search('4', true);
// false
```
Alternatively, you may pass in your own callback to search for the first item that passes your truth test:
```js
collection.search((item, key) => item > 5);
// 2
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/search.js)

30
node_modules/collect.js/docs/api/shift.md generated vendored Executable file
View File

@@ -0,0 +1,30 @@
# `shift()`
The shift method removes and returns the first item from the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.shift();
// 1
collection.all();
// [2, 3, 4, 5]
```
You may provide number of items to shift. This will return the shifted items in a new collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
collection.shift(2).all();
// [1, 2]
collection.all();
// => [3, 4, 5]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/shift.js)

15
node_modules/collect.js/docs/api/shuffle.md generated vendored Executable file
View File

@@ -0,0 +1,15 @@
# `shuffle()`
The shuffle method randomly shuffles the items in the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
const shuffled = collection.shuffle();
shuffled.all();
// [3, 5, 1, 2, 4] (generated randomly)
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/shuffle.js)

27
node_modules/collect.js/docs/api/skip.md generated vendored Executable file
View File

@@ -0,0 +1,27 @@
# `skip()`
The skip method returns a new collection, without the first given amount of items:
```js
const collection = collect([1, 2, 3, 4, 5, 6]);
collection.skip(4).all();
// [5, 6]
```
```js
const collection = collect({
first: 'first',
second: 'second',
third: 'third',
fourth: 'fourth',
fifth: 'fifth',
});
collection.skip(4).all();
// { fifth: 'fifth' }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/skip.js)

27
node_modules/collect.js/docs/api/skipUntil.md generated vendored Executable file
View File

@@ -0,0 +1,27 @@
# `skipUntil()`
The `skipUntil` method skips items until the given callback returns `true` and then returns the remaining items in the collection:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.skipUntil(item => item >= 3);
subset.all();
// [3, 4]
```
You may also pass a simple value to the `skipUntil` method to skip all items until the given value is found:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.skipUntil(3);
subset.all();
// [3, 4]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/skipUntil.js)

29
node_modules/collect.js/docs/api/skipWhile.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `skipWhile()`
The `skipWhile` method skips items while the given callback returns `true` and then returns the remaining items in the collection:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.skipWhile(item => item <= 3);
subset.all();
// [4]
```
> If the callback never returns true, the skipWhile method will return an empty collection.
You may also pass a simple value to the `skipWhile`:
```js
const collection = collect([1, 1, 2, 2, 3, 3, 4, 4]);
const subset = collection.skipWhile(1);
subset.all();
// [2, 2, 3, 3, 4, 4]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/skipWhile.js)

25
node_modules/collect.js/docs/api/slice.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `slice()`
The slice method returns a slice of the collection starting at the given index:
```js
const collection = collect([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]);
const slice = collection.slice(4);
slice.all();
// [5, 6, 7, 8, 9, 10]
```
If you would like to limit the size of the returned slice, pass the desired size as the second argument to the method:
```js
const slice = collection.slice(4, 2);
slice.all();
// [5, 6]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/slice.js)

42
node_modules/collect.js/docs/api/sole.md generated vendored Executable file
View File

@@ -0,0 +1,42 @@
# `sole()`
The sole method returns the first element in the collection that passes a given truth test, but only if the truth test matches exactly one element:
```js
collect([1, 2, 3, 4]).sole(item => item === 1);
// 1
```
If there are no elements in the collection that should be returned by the sole method, then an error will be thrown:
```js
collect([1, 2, 3, 4]).sole(item => item > 4);
// Error ('Item not found.') is thrown.
```
If there are multiple elements in the collection that should be returned by the sole method, then an error will be thrown:
```js
collect([1, 2, 3, 4]).sole();
// Error ('Multiple items found.') is thrown.
```
Like the firstOrFail method, you may also pass an attribute, operator, and value:
```js
const collection = collect([
{ product: 'Desk', price: 200, discounted: true },
{ product: 'Chair', price: 100, discounted: true },
{ product: 'Bookcase', price: 150, discounted: true },
{ product: 'Door', price: 100 },
]);
collection.sole('product', '=', 'Desk');
// { product: 'Desk', price: 200, discounted: true }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sole.js)

5
node_modules/collect.js/docs/api/some.md generated vendored Executable file
View File

@@ -0,0 +1,5 @@
# `some()`
Alias for the [contains](#contains) method.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/some.js)

29
node_modules/collect.js/docs/api/sort.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `sort()`
The sort method sorts the collection:
```js
const collection = collect([5, 3, 1, 2, 4]);
const sorted = collection.sort();
sorted.all();
// [1, 2, 3, 4, 5]
```
> If your sorting needs are more advanced, you may pass a callback to sort with your own algorithm.
```js
const collection = collect([5, 3, 1, 2, 4]);
const sorted = collection.sort((a, b) => b - a);
sorted.all();
// [5, 4, 3, 2, 1]
```
> If you need to sort a collection of nested arrays or objects, see the `sortBy` and `sortByDesc` methods.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sort.js)

98
node_modules/collect.js/docs/api/sortBy.md generated vendored Executable file
View File

@@ -0,0 +1,98 @@
# `sortBy()`
The sortBy method sorts the collection by the given key. The sorted collection keeps the original array keys, so in this example we'll use the values method to reset the keys to consecutively numbered indexes:
```js
const collection = collect([
{ name: 'Desk', price: 200 },
{ name: 'Chair', price: 100 },
{ name: 'Bookcase', price: 150 },
]);
const sorted = collection.sortBy('price');
sorted.all();
// [
// { name: 'Chair', price: 100 },
// { name: 'Bookcase', price: 150 },
// { name: 'Desk', price: 200 },
// ]
```
You can use dot notation to sort by nested values
```js
const collection = collect([
{
name: 'Desk',
price: 200,
manufacturer: {
name: 'IKEA',
},
},
{
name: 'Chair',
price: 100,
manufacturer: {
name: 'Herman Miller',
},
},
{
name: 'Bookcase',
price: 150,
manufacturer: {
name: 'IKEA',
},
},
]);
const sorted = collection.sortBy('manufacturer.name');
sorted.all();
// [
// {
// name: 'Chair',
// price: 100,
// manufacturer: {
// name: 'Herman Miller',
// },
// },
// {
// name: 'Desk',
// price: 200,
// manufacturer: {
// name: 'IKEA',
// },
// },
// {
// name: 'Bookcase',
// price: 150,
// manufacturer: {
// name: 'IKEA',
// },
// },
// ]
```
You can also pass your own callback to determine how to sort the collection values:
```js
const collection = collect([
{ name: 'Desk', colors: ['Black', 'Mahogany'] },
{ name: 'Chair', colors: ['Black'] },
{ name: 'Bookcase', colors: ['Red', 'Beige', 'Brown'] },
]);
const sorted = collection.sortBy((product, key) => product.colors.length);
sorted.all();
// [
// { name: 'Chair', colors: ['Black'] },
// { name: 'Desk', colors: ['Black', 'Mahogany'] },
// { name: 'Bookcase', colors: ['Red', 'Beige', 'Brown'] },
// ]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sortBy.js)

5
node_modules/collect.js/docs/api/sortByDesc.md generated vendored Executable file
View File

@@ -0,0 +1,5 @@
# `sortByDesc()`
This method has the same signature as the `sortBy` method, but will sort the collection in the opposite order.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sortByDesc.js)

17
node_modules/collect.js/docs/api/sortDesc.md generated vendored Executable file
View File

@@ -0,0 +1,17 @@
# `sortDesc()`
This method will sort the collection in the opposite order as the `sort` method.
```js
const collection = collect([1, 3, 5, 2, 4]);
const sorted = collection.sortDesc();
sorted.all();
// [5, 4, 3, 2, 1]
```
Unlike `sort`, you may not pass a callback to `sortDesc`. If you wish to use a callback, you should use `sort` and invert your comparison.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sortDesc.js)

23
node_modules/collect.js/docs/api/sortKeys.md generated vendored Executable file
View File

@@ -0,0 +1,23 @@
# `sortKeys()`
The sortKeys method sorts the collection by the keys of the underlying associative array:
```js
const collection = collect({
id: 10,
first: 'Darwin',
last: 'Núñez',
});
const sorted = collection.sortKeys();
sorted.all();
// {
// first: 'Darwin',
// id: 10,
// last: 'Núñez',
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sortKeys.js)

4
node_modules/collect.js/docs/api/sortKeysDesc.md generated vendored Executable file
View File

@@ -0,0 +1,4 @@
# `sortKeysDesc()`
This method has the same signature as the [sortKeys](#sortkeys) method, but will sort the collection in the opposite order.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sortKeysDesc.js)

51
node_modules/collect.js/docs/api/splice.md generated vendored Executable file
View File

@@ -0,0 +1,51 @@
# `splice()`
The splice method removes and returns a slice of items starting at the specified index:
```js
const collection = collect([1, 2, 3, 4, 5]);
const chunk = collection.splice(2);
chunk.all();
// [3, 4, 5]
collection.all();
// [1, 2]
```
You may pass a second argument to limit the size of the resulting chunk:
```js
const collection = collect([1, 2, 3, 4, 5]);
const chunk = collection.splice(2, 1);
chunk.all();
// [3]
collection.all();
// [1, 2, 4, 5]
```
In addition, you can pass a third argument containing the new items to replace the items removed from the collection:
```js
const collection = collect([1, 2, 3, 4, 5]);
const chunk = collection.splice(2, 1, [10, 11]);
chunk.all();
// [3]
collection.all();
// [1, 2, 10, 11, 4, 5]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/splice.js)

13
node_modules/collect.js/docs/api/split.md generated vendored Executable file
View File

@@ -0,0 +1,13 @@
# `split()`
The split method breaks a collection into the given number of groups:
```js
const collection = collect([1, 2, 3, 4, 5]);
const groups = collection.split(3);
// [[1, 2], [3, 4], [5]]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/split.js)

38
node_modules/collect.js/docs/api/sum.md generated vendored Executable file
View File

@@ -0,0 +1,38 @@
# `sum()`
The sum method returns the sum of all items in the collection:
```js
collect([1, 2, 3]).sum();
// 6
```
If the collection contains nested arrays or objects, you should pass a key to use for determining which values to sum:
```js
const collection = collect([
{ name: 'My story', pages: 176 },
{ name: 'Fantastic Beasts and Where to Find Them', pages: 1096 },
]);
collection.sum('pages');
// 1272
```
In addition, you may pass your own callback to determine which values of the collection to sum:
```js
const collection = collect([
{ name: 'Desk', colors: ['Black', 'Mahogany'] },
{ name: 'Chair', colors: ['Black'] },
{ name: 'Bookcase', colors: ['Red', 'Beige', 'Brown'] },
]);
const total = collection.sum(product => product.colors.length);
// 6
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/sum.js)

16
node_modules/collect.js/docs/api/take.md generated vendored Executable file
View File

@@ -0,0 +1,16 @@
# `take()`
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:
```js
const collection = collect([0, 1, 2, 3, 4, 5]);
const chunk = collection.take(3);
chunk.all();
// [0, 1, 2]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/take.js)

29
node_modules/collect.js/docs/api/takeUntil.md generated vendored Executable file
View File

@@ -0,0 +1,29 @@
# `takeUntil()`
The `takeUntil` method returns items in the collection until the given callback returns `true`:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.takeUntil(item => item >= 3);
subset.all();
// [1, 2]
```
> If the given value is not found or the callback never returns `true`, the `takeUntil` method will return all items in the collection.
You may also pass a simple value to the `takeUntil` method to get the items until the given value is found:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.takeUntil(3);
subset.all();
// [1, 2]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/takeUntil.js)

17
node_modules/collect.js/docs/api/takeWhile.md generated vendored Executable file
View File

@@ -0,0 +1,17 @@
# `takeWhile()`
The `takeWhile` method returns items in the collection until the given callback returns `false`:
```js
const collection = collect([1, 2, 3, 4]);
const subset = collection.takeWhile(item => item < 3);
subset.all();
// [1, 2]
```
> If the callback never returns `false`, the `takeWhile` method will return all items in the collection.
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/takeWhile.js)

18
node_modules/collect.js/docs/api/tap.md generated vendored Executable file
View File

@@ -0,0 +1,18 @@
# `tap()`
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:
```js
collect([2, 4, 3, 1, 5])
.sort()
.tap((collection) => {
console.log(collection.all());
// [1, 2, 3, 4, 5]
})
.shift();
// 1
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/tap.js)

13
node_modules/collect.js/docs/api/times.md generated vendored Executable file
View File

@@ -0,0 +1,13 @@
# `times()`
The times method creates a new collection by invoking the callback a given amount of times:
```js
const collection = collect().times(10, number => number * 9);
collection.all();
// [9, 18, 27, 36, 45, 54, 63, 72, 81, 90]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/times.js)

25
node_modules/collect.js/docs/api/toArray.md generated vendored Executable file
View File

@@ -0,0 +1,25 @@
# `toArray()`
The toArray method converts the collection into a plain array.
If the collection is an object, an array containing the values will be returned.
```js
const collection = collect([1, 2, 3, 'b', 'c']);
collection.toArray();
// [1, 2, 3, 'b', 'c']
```
```js
const collection = collect({
name: 'Elon Musk',
companies: ['Tesla', 'Space X', 'SolarCity'],
});
collection.toArray();
// ['Elon Musk', ['Tesla', 'Space X', 'SolarCity']]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/toArray.js)

Some files were not shown because too many files have changed in this diff Show More