Collection | The Extollo Framework

A helper class for working with arrays of items in a more robust fashion. Provides helpers for accessing sub-keys, filtering, piping, and aggregate functions.

Type parameters

Hierarchy

Collection

Index

Methods

Constructors

constructor

new Collection<T>(items?: T[]): Collection<T>

- Defined in src/util/collection/Collection.ts:90
Type parameters
- T
Parameters
- Optional items: T[]
Returns Collection<T>

Properties

Private storedItems

storedItems: T[] = []

Accessors

length

get length(): number

- Defined in src/util/collection/Collection.ts:650
Get the number of items in the collection.

Returns number

Methods

[Symbol.iterator]

[Symbol.iterator](): Iterator<T, any, undefined>

- Defined in src/util/collection/Collection.ts:1321
Returns Iterator<T, any, undefined>

all

all(): T[]

- Defined in src/util/collection/Collection.ts:142
Cast the collection to an array.

Returns T[]

Private allAsNumbers

allAsNumbers<T2>(key: KeyOperator<T, T2>): number[]

- Defined in src/util/collection/Collection.ts:113
Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns number[]

Private allAssociated

allAssociated<T2>(key: KeyOperator<T, T2>): AssociatedCollectionItem<T2, T>[]

- Defined in src/util/collection/Collection.ts:117
Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns AssociatedCollectionItem<T2, T>[]

Private allOperator

allOperator<T2>(key: KeyOperator<T, T2>): T2[]

- Defined in src/util/collection/Collection.ts:103
Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns T2[]

associate

associate<T2>(key: KeyOperator<T, T2>): any

- Defined in src/util/collection/Collection.ts:721
Return an object mapping the given key to the record with that key. See keyBy().

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns any

asyncMapRight

asyncMapRight<TLeft, TRight>(func: KeyFunction<T, Awaitable<Either<TLeft, TRight>>>): Promise<Either<TLeft, Collection<TRight>>>

- Defined in src/util/collection/Collection.ts:357
Create a new collection by mapping the items in this collection using the given function where the function returns an Either. The collection is all Right instances. If a Left is encountered, that value is returned.

Type parameters
- TLeft
- TRight
Parameters
- func: KeyFunction<T, Awaitable<Either<TLeft, TRight>>>
Returns Promise<Either<TLeft, Collection<TRight>>>

asyncPipe

asyncPipe(): AsyncPipe<Collection<T>>

- Defined in src/util/collection/Collection.ts:941
Return a new AsyncPipe of this collection.

Returns AsyncPipe<Collection<T>>

at

at(index: number): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:681
Return the item at the given index in the collection, if it exists.

Parameters
- index: number
Returns MaybeCollectionItem<T>

average

average<T2>(key?: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:150
Get the average value of the items or one of their keys.

Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns number

awaitAll

awaitAll(): Promise<Collection<Awaited<T>>>

- Defined in src/util/collection/Collection.ts:400
Await all values in the collection.

Returns Promise<Collection<Awaited<T>>>

awaitMapCall

awaitMapCall<T2>(method: T2, ...params: Parameters<T[T2]>): Promise<Collection<Awaited<ReturnType<T[T2]>>>>

- Defined in src/util/collection/Collection.ts:393
Shortcut for .mapCall(...).awaitAll().

Type parameters
- T2: string | number | symbol
Parameters
- method: T2
- Rest ...params: Parameters<T[T2]>
Returns Promise<Collection<Awaited<ReturnType<T[T2]>>>>

clone

clone(): Collection<T>

- Defined in src/util/collection/Collection.ts:251
Create a copy of this collection. Does NOT deep copy the underlying items.

Returns Collection<T>

collapse

collapse(): Collection<any>

- Defined in src/util/collection/Collection.ts:208
Collapse a (potentially nested) collection of items down to a single dimension.

Returns Collection<any>

concat

concat(items: CollectionComparable<T>): Collection<T>

- Defined in src/util/collection/Collection.ts:977
Push the given items to the end of this collection. Unlike merge(), this mutates the current collection's items.

Parameters
- items: CollectionComparable<T>
Returns Collection<T>

contains

contains<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): boolean

- Defined in src/util/collection/Collection.ts:239
Returns true if the given key matches the given condition for any item in the collection.
example
```
const userExists = users.contains('username', '=', 'jdoe')
```
Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns boolean

count

count(): number

- Defined in src/util/collection/Collection.ts:657
Get the number of items in the collection.

Returns number

diff

diff<T2>(items: CollectionComparable<T | T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:259
Return a collection of items that ARE in this collection, but NOT in the items collection.

Type parameters
- T2
Parameters
- items: CollectionComparable<T | T2>
Returns Collection<T>

diffInPlace

diffInPlace<T2>(items: CollectionComparable<T | T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:274
Like diff, but mutates the current collection.

Type parameters
- T2
Parameters
- items: CollectionComparable<T | T2>
Returns Collection<T>

diffUsing

diffUsing<T2>(items: CollectionComparable<T | T2>, compare: DeterminesEquality<T>): Collection<T>

- Defined in src/util/collection/Collection.ts:292
Return a collection of items that ARE in this collection, but NOT In the items collection using a helper function to determine whether two items are equal.
example
```
potentialUsers.diffUsing(storedUsers, (u1, u2) => u1.username.toLowerCase() === u2.username.toLowerCase())
```
Type parameters
- T2
Parameters
- items: CollectionComparable<T | T2>
- compare: DeterminesEquality<T>
Returns Collection<T>

each

each<T2>(func: KeyFunction<T, T2>): void

- Defined in src/util/collection/Collection.ts:316
Execute the function for every item in the collection.

Type parameters
- T2
Parameters
- func: KeyFunction<T, T2>
Returns void

every

every<T2>(func: KeyFunction<T, T2>): boolean

- Defined in src/util/collection/Collection.ts:484
Returns true if the given function returns true for every item in the collection.

Type parameters
- T2
Parameters
- func: KeyFunction<T, T2>
Returns boolean

everyWhere

everyWhere<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): boolean

- Defined in src/util/collection/Collection.ts:488
Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns boolean

filter

filter<T2>(func?: KeyFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:497
Return a new collection filtered by the given function.

Type parameters
- T2
Parameters
- Optional func: KeyFunction<T, T2>
Returns Collection<T>

filterOut

filterOut<T2>(func?: KeyFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:505
Like filter, but inverted. That is, removes items that DO match the criterion.

Type parameters
- T2
Parameters
- Optional func: KeyFunction<T, T2>
Returns Collection<T>

find

find<T2>(func: KeyFunction<T, T2>): undefined | number

- Defined in src/util/collection/Collection.ts:517
Returns the index of the record for which the given function returns true, if such an index exists.

Type parameters
- T2
Parameters
- func: KeyFunction<T, T2>
Returns undefined | number

first

first(): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:615
Return the first item in the collection, if it exists.

Returns MaybeCollectionItem<T>

firstWhere

firstWhere<T2>(key: KeyOperator<T, T2>, operator?: WhereOperator, operand?: any): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:627
Return the first item in the collection that matches the given where-condition.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator = '='
- operand: any = true
Returns MaybeCollectionItem<T>

firstWhereNot

firstWhereNot<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:640
Return the first item in the collection that does NOT match the given where-condition.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns MaybeCollectionItem<T>

forPage

forPage(page: number, perPage: number): Collection<T>

- Defined in src/util/collection/Collection.ts:920
Return the items that should exist on the given page, assuming there are perPage many items on a single page.

Parameters
- page: number
- perPage: number
Returns Collection<T>

get

get(index: number, fallback?: T): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:669
Get the item at the given index in the collection. If none exists, return the fallback.

Parameters
- index: number
- Optional fallback: T
Returns MaybeCollectionItem<T>

groupBy

groupBy<T2>(key: KeyOperator<T, T2>): any

Return an object mapping key values to arrays of records with that key.

example

const users = collect([
 {uid: 1, name: 'John', type: 'admin'},
 {uid: 2, name: 'Jane', type: 'user'},
 {uid: 3, name: 'James', type: 'user'},
])

users.groupBy('type')  // => {admin: [{uid: 1, ...}], user: [{uid: 2, ...}, {uid: 3, ...}]}

Type parameters

Parameters

key: KeyOperator<T, T2>

Returns any

implode

implode(delimiter: string): string

- Defined in src/util/collection/Collection.ts:742
Join the items in the collection to a string delimited by the given delimiter.

Parameters
- delimiter: string
Returns string

includes

includes(item: T): boolean

- Defined in src/util/collection/Collection.ts:1277
Returns true if the given item is in this collection.

Parameters
- item: T
Returns boolean

intersect

intersect(items: CollectionComparable<T>, key?: KeyOperator<T, T>): Collection<T>

- Defined in src/util/collection/Collection.ts:752
Return a collection of the items that exist in both this collection and this collection, (optionally) using the given key to compare.

Parameters
- items: CollectionComparable<T>
- Optional key: KeyOperator<T, T>
Returns Collection<T>

isEmpty

isEmpty(): boolean

- Defined in src/util/collection/Collection.ts:778
True if the collection has no items.

Returns boolean

isNotEmpty

isNotEmpty(): boolean

- Defined in src/util/collection/Collection.ts:785
True if the collection has at least one item.

Returns boolean

join

join(delimiter: string): string

- Defined in src/util/collection/Collection.ts:734
Join the items in the collection to a string delimited by the given delimiter.

Parameters
- delimiter: string
Returns string

keyBy

keyBy(key: KeyOperator<T, string>): {}

- Defined in src/util/collection/Collection.ts:440
Convert this collection to an object keyed by the given field.
example
```
const users = collect([{uid: 1, name: 'John'}, {uid: 2, name: 'Jane'}])
users.keyBy('name')  // => {John: {uid: 1, name: 'John'}, Jane: {uid: 2, name: 'Jane'}}
```
Parameters
- key: KeyOperator<T, string>
Returns {}
- [key: string]: T

keyMap

keyMap<T2>(key: KeyOperator<T, string>, value: KeyOperator<T, T2>): {}

- Defined in src/util/collection/Collection.ts:463
Convert this collection to an object keyed by the given field, whose values are the output of the value operator.
example
```
const users = collect([{uid: 1, name: 'John'}, {uid: 2, name: 'Jane'}])
users.keyMap('name', 'uid')  // => {John: 1, Jane: 2}
```
Type parameters
- T2
Parameters
- key: KeyOperator<T, string>
- value: KeyOperator<T, T2>
Returns {}
- [key: string]: T2

last

last(): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:792
Return the last item in the collection.

Returns MaybeCollectionItem<T>

lastWhere

lastWhere<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:804
Return the last item in the collection that matches the given where-condition.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns MaybeCollectionItem<T>

lastWhereNot

lastWhereNot<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:817
Return the last item in the collection that does NOT match the given where-condition.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns MaybeCollectionItem<T>

map

map<T2>(func: KeyFunction<T, T2>): Collection<T2>

- Defined in src/util/collection/Collection.ts:324
Create a new collection by mapping the items in this collection using the given function.

Type parameters
- T2
Parameters
- func: KeyFunction<T, T2>
Returns Collection<T2>

mapCall

mapCall<T2>(method: T2, ...params: Parameters<T[T2]>): Collection<ReturnType<T[T2]>>

- Defined in src/util/collection/Collection.ts:384
Map a method on the underlying type, passing it any required parameters. This is delightfully type-safe.

Type parameters
- T2: string | number | symbol
Parameters
- method: T2
- Rest ...params: Parameters<T[T2]>
Returns Collection<ReturnType<T[T2]>>

mapRight

mapRight<TLeft, TRight>(func: KeyFunction<T, Either<TLeft, TRight>>): Either<TLeft, Collection<TRight>>

- Defined in src/util/collection/Collection.ts:338
Create a new collection by mapping the items in this collection using the given function where the function returns an Either. The collection is all Right instances. If a Left is encountered, that value is returned.

Type parameters
- TLeft
- TRight
Parameters
- func: KeyFunction<T, Either<TLeft, TRight>>
Returns Either<TLeft, Collection<TRight>>

max

max<T2>(key: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:848
Return the max value of the given key.

Type parameters
- T2 = T
Parameters
- key: KeyOperator<T, T2>
Returns number

median

median<T2>(key?: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:169
Get the median value of the items or one of their keys.

Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns number

merge

merge<T2>(items: CollectionComparable<T2>): Collection<T | T2>

- Defined in src/util/collection/Collection.ts:882
Get a new collection containing both the items in this collection, and the items collection.

Type parameters
- T2
Parameters
- items: CollectionComparable<T2>
Returns Collection<T | T2>

min

min<T2>(key: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:865
Return the min value of the given key.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns number

mode

mode<T2>(key?: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:189
Get the mode of the items or one of their keys.

Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns number

nth

nth(n: number): Collection<T>

Return every nth item in the collection.

example

const items = collect(['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i'])

items.nth(3)  // => Collection['a', 'd', 'g']

Parameters

n: number

Returns Collection<T>

pad

pad(length: number, value: T): Collection<T>

- Defined in src/util/collection/Collection.ts:1286
Add on to the end of this collection as many value items as necessary until the collection is length long.

Parameters
- length: number
- value: T
Returns Collection<T>

partialMap

partialMap<T2>(func: KeyFunction<T, undefined | T2>): Collection<NonNullable<T2>>

- Defined in src/util/collection/Collection.ts:416
Create a new collection by mapping the items in this collection using the given function, excluding any for which the function returns undefined.

Type parameters
- T2
Parameters
- func: KeyFunction<T, undefined | T2>
Returns Collection<NonNullable<T2>>

pipe

pipe<TOut>(builder: (pipeline: Pipeline<Collection<T>, Collection<T>>) => Pipeline<Collection<T>, TOut>): TOut

- Defined in src/util/collection/Collection.ts:934
Build and apply a pipeline.

Type parameters
- TOut
Parameters
- builder: (pipeline: Pipeline<Collection<T>, Collection<T>>) => Pipeline<Collection<T>, TOut>
  - - (pipeline: Pipeline<Collection<T>, Collection<T>>): Pipeline<Collection<T>, TOut>
    - Parameters
      - pipeline: Pipeline<Collection<T>, Collection<T>>
      Returns Pipeline<Collection<T>, TOut>
Returns TOut

pipeTo

pipeTo<TOut>(pipeline: Pipeline<Collection<T>, TOut>): TOut

- Defined in src/util/collection/Collection.ts:929
Return a new Pipe of this collection.

Type parameters
- TOut
Parameters
- pipeline: Pipeline<Collection<T>, TOut>
Returns TOut

pluck

pluck<T2>(key: T2): Collection<T[T2]>

Map the collection to a collection of the values of the key.

example

const users = collect([
 {uid: 1, name: 'John', type: 'admin'},
 {uid: 2, name: 'Jane', type: 'user'},
 {uid: 3, name: 'James', type: 'user'},
])

users.pluck('name')  // => Collection['John', 'Jane', 'James']

Type parameters

T2: string | number | symbol

Parameters

key: T2

Returns Collection<T[T2]>

pop

pop(): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:948
Remove the last item from this collection.

Returns MaybeCollectionItem<T>

prepend

prepend(item: T): Collection<T>

- Defined in src/util/collection/Collection.ts:958
Add the given item to the beginning of this collection.

Parameters
- item: T
Returns Collection<T>

promiseMap

promiseMap<T2>(func: KeyFunction<T, T2 | Promise<T2>>): Promise<Collection<T2>>

Like map(), but the callback can be async.

example

A trivial example, but demonstrative:

const collection = collect([1, 2, 3])

collection.map(async item => item + 1)  // => Collection[Promise<1>, Promise<2>, Promise<3>]

collection.promiseMap(async item => item + 1)  // => Promise<Collection[2, 3, 4]>

Type parameters

Parameters

func: KeyFunction<T, T2 | Promise<T2>>

Returns Promise<Collection<T2>>

push

push(item: T): Collection<T>

- Defined in src/util/collection/Collection.ts:967
Add the given item to the end of this collection.

Parameters
- item: T
Returns Collection<T>

put

put(index: number, item: T): Collection<T>

- Defined in src/util/collection/Collection.ts:990
Insert the given item into this collection at the specified index.

Parameters
- index: number
- item: T
Returns Collection<T>

random

random(n: number): Collection<T>

- Defined in src/util/collection/Collection.ts:1012
Return n many randomly-selected items from this collection.

Parameters
- n: number
Returns Collection<T>

reduce

reduce<T2>(reducer: KeyReducerFunction<T, T2>, initialValue?: T2): undefined | T2

- Defined in src/util/collection/Collection.ts:1040
Reduce this collection to a single value using the given reducer function.
example
```
const items = collect([1, 3, 5, 7])

items.reduce((sum, item) => sum + item, 0)  // => 16
```
Type parameters
- T2
Parameters
- reducer: KeyReducerFunction<T, T2>
- Optional initialValue: T2
Returns undefined | T2

reject

reject<T2>(truthTestFunction: KeyFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:1053
Return a new collection of items that fail the given truth-test function.

Type parameters
- T2
Parameters
- truthTestFunction: KeyFunction<T, T2>
Returns Collection<T>

reverse

reverse(): Collection<T>

- Defined in src/util/collection/Collection.ts:1063
Return a new collection whose items are in the reverse order of the current one.

Returns Collection<T>

search

search(item: T): MaybeCollectionIndex

- Defined in src/util/collection/Collection.ts:1071
Try to find the given item in the collection. If it exists, return the index.

Parameters
- item: T
Returns MaybeCollectionIndex

shift

shift(): MaybeCollectionItem<T>

- Defined in src/util/collection/Collection.ts:1085
Remove and return the first item in the collection, if it exists.

Returns MaybeCollectionItem<T>

shuffle

shuffle(): Collection<T>

- Defined in src/util/collection/Collection.ts:1094
Shuffle the items in this collection to a random order.

Returns Collection<T>

slice

slice(start: number, end: number): Collection<T>

- Defined in src/util/collection/Collection.ts:1108
Return a sub-set of this collection between the given index ranges.

Parameters
- start: number
- end: number
Returns Collection<T>

some

some(func: (item: T) => Maybe<boolean>): boolean

- Defined in src/util/collection/Collection.ts:308
Returns true if the given function returns truthy for any item in the collection. Stops executing if a single truth case is found.

Parameters
- func: (item: T) => Maybe<boolean>
  - - (item: T): Maybe<boolean>
    - Parameters
      - item: T
      Returns Maybe<boolean>
Returns boolean

sort

sort(comparisonFunction?: ComparisonFunction<T>): Collection<T>

- Defined in src/util/collection/Collection.ts:1119
Sort the collection (optionally) using the given comparison function.

Parameters
- Optional comparisonFunction: ComparisonFunction<T>
Returns Collection<T>

sortBy

sortBy<T2>(key?: KeyOperator<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:1134
Sort the collection (optionally) using the given key operator.

Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns Collection<T>

sortByDesc

sortByDesc<T2>(key?: KeyOperator<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:1169
Identical to sortBy(), but in reverse order.

Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns Collection<T>

sortDesc

sortDesc(comparisonFunction?: ComparisonFunction<T>): Collection<T>

- Defined in src/util/collection/Collection.ts:1161
Identical to sort(), but in reverse order.

Parameters
- Optional comparisonFunction: ComparisonFunction<T>
Returns Collection<T>

splice

splice(start: number, deleteCount?: number): Collection<T>

- Defined in src/util/collection/Collection.ts:1178
Remove deleteCount many items from the collection, starting at the start index.

Parameters
- start: number
- Optional deleteCount: number
Returns Collection<T>

strings

strings(): Collection<string>

- Defined in src/util/collection/Collection.ts:407
Map each element in the collection to a string.

Returns Collection<string>

sum

sum<T2>(key?: KeyOperator<T, T2>): number

- Defined in src/util/collection/Collection.ts:1194
Return the sum of the items in the collection, optionally by key.
example
```
const items = collect([{k1: 1}, {k1: 3}, {k1: 5}, {k1: 7}])

items.sum('k1')  // => 16
```
Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns number

take

take(limit: number): Collection<T>

- Defined in src/util/collection/Collection.ts:1209
Return a collection of the first limit many items in this collection. If limit is negative, returns the last limit many items.

Parameters
- limit: number
Returns Collection<T>

tap

tap<T2>(func: CollectionFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:1235
Apply the given function to this collection then return the collection. This is intended to help with chaining.
example
```
collection.tap(coll => {
        coll.push(item)
    })
    .where('someKey', '>', 4)
    // ... &c.
```
Type parameters
- T2
Parameters
- func: CollectionFunction<T, T2>
Returns Collection<T>

toArray

toArray(recursive?: boolean): any[]

- Defined in src/util/collection/Collection.ts:1297
Cast the collection to an array.

Parameters
- recursive: boolean = true
Returns any[]

toAsync

toAsync(): AsyncCollection<T>

- Defined in src/util/collection/Collection.ts:373
Get the collection as an AsyncCollection.

Returns AsyncCollection<T>

toJSON

toJSON(replacer?: undefined, space?: number): string

- Defined in src/util/collection/Collection.ts:1314
Cast the collection to a JSON string, optionally specifying the replacer and indentation.

Parameters
- replacer: undefined = ...
- space: number = 4
Returns string

unique

unique<T2>(key?: KeyOperator<T, T2>): Collection<T | T2>

- Defined in src/util/collection/Collection.ts:1257
Return all distinct items in this collection. If a key is specified, returns all unique values of that key.
example
```
const users = collect([
 {uid: 1, name: 'John', type: 'admin'},
 {uid: 2, name: 'Jane', type: 'user'},
 {uid: 3, name: 'James', type: 'user'},
])

users.unique('type')  // => Collection['admin', 'user']
```
Type parameters
- T2
Parameters
- Optional key: KeyOperator<T, T2>
Returns Collection<T | T2>

unless

unless<T2>(bool: boolean, then: CollectionFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:547
When bool is falsy, execute the callback, passing in the collection. Can be used for functional-style chained calls.

Type parameters
- T2
Parameters
- bool: boolean
- then: CollectionFunction<T, T2>
Returns Collection<T>

when

when<T2>(bool: boolean, then: CollectionFunction<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:534
When bool is truthy, execute the callback, passing in the collection. Can be used for functional-style chained calls.

Type parameters
- T2
Parameters
- bool: boolean
- then: CollectionFunction<T, T2>
Returns Collection<T>

where

where<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): Collection<T>

Filter the collection by the given where-condition.

example

const users = collect([
 {uid: 1, name: 'John'},
 {uid: 2, name: 'Jane'},
 {uid: 3, name: 'James'},
])

users.where('uid', '<', 3)  // => Collection[{uid: 1, name: 'John'}, {uid: 2, name: 'Jane'}]

Type parameters

Parameters

key: KeyOperator<T, T2>
operator: WhereOperator
Optional operand: unknown

Returns Collection<T>

whereDefined

whereDefined(): Collection<NonNullable<T>>

- Defined in src/util/collection/Collection.ts:509
Returns Collection<NonNullable<T>>

whereIn

whereIn<T2>(key: KeyOperator<T, T2>, items: CollectionComparable<T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:592
Filter the collection for all records where the given key is in a set of items.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- items: CollectionComparable<T2>
Returns Collection<T>

whereMax

whereMax<T2>(key: KeyOperator<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:857
Return the item with the max value of the given key.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns Collection<T>

whereMin

whereMin<T2>(key: KeyOperator<T, T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:874
Return the item with the min value of the given key.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
Returns Collection<T>

whereNot

whereNot<T2>(key: KeyOperator<T, T2>, operator: WhereOperator, operand?: unknown): Collection<T>

- Defined in src/util/collection/Collection.ts:583
Filter the collection by the inverse of the given where-condition.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- operator: WhereOperator
- Optional operand: unknown
Returns Collection<T>

whereNotIn

whereNotIn<T2>(key: KeyOperator<T, T2>, items: CollectionComparable<T2>): Collection<T>

- Defined in src/util/collection/Collection.ts:608
Filter the collection for all records where the given key is NOT in a set of items.

Type parameters
- T2
Parameters
- key: KeyOperator<T, T2>
- items: CollectionComparable<T2>
Returns Collection<T>

Static collect

collect<T2>(items: T2[]): Collection<T2>

- Defined in src/util/collection/Collection.ts:55
Create a new collection from an array of items.

Type parameters
- T2
Parameters
- items: T2[]
Returns Collection<T2>

Static fill

fill<T2>(size: number, item: T2): Collection<T2>

- Defined in src/util/collection/Collection.ts:87
Fill a new collection of the given size with the given item.

Type parameters
- T2
Parameters
- size: number
- item: T2
Returns Collection<T2>

Static normalize

normalize<T2>(itemOrItems: undefined | T2 | (undefined | T2)[]): Collection<T2>

- Defined in src/util/collection/Collection.ts:64
Create a new collection from an item or array of items. Filters out undefined items.

Type parameters
- T2
Parameters
- itemOrItems: undefined | T2 | (undefined | T2)[]
Returns Collection<T2>

Static size

size(size: number): Collection<undefined>

- Defined in src/util/collection/Collection.ts:77
Create a collection of "undefined" elements of a given size.

Parameters
- size: number
Returns Collection<undefined>

Type parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T

Parameters

Optional items: T[]

Returns Collection<T>

Properties

Private storedItems

Accessors

length

Returns number

Methods

[Symbol.iterator]

Returns Iterator<T, any, undefined>

all

Returns T[]

Private allAsNumbers

Type parameters

T2

Parameters

key: KeyOperator<T, T2>

Returns number[]

Private allAssociated

Type parameters

T2

Parameters

key: KeyOperator<T, T2>

Returns AssociatedCollectionItem<T2, T>[]

Private allOperator

Type parameters

T2

Parameters

key: KeyOperator<T, T2>

Returns T2[]

associate

Type parameters

T2

Parameters

key: KeyOperator<T, T2>

Returns any

asyncMapRight

Type parameters

TLeft

TRight

Parameters

func: KeyFunction<T, Awaitable<Either<TLeft, TRight>>>

Returns Promise<Either<TLeft, Collection<TRight>>>

asyncPipe

Returns AsyncPipe<Collection<T>>

at

Parameters

index: number

Returns MaybeCollectionItem<T>

average

Type parameters

T2

Parameters

Optional key: KeyOperator<T, T2>

Returns number

awaitAll

Returns Promise<Collection<Awaited<T>>>

awaitMapCall

Type parameters

T2: string | number | symbol

Parameters

method: T2

Rest ...params: Parameters<T[T2]>

Returns Promise<Collection<Awaited<ReturnType<T[T2]>>>>

clone

Returns Collection<T>

collapse