Utils: `arrays`
Table of contents
Functions
- castArray
- chunk
- chunkIter
- concat
- flatten
- flattenDeep
- getFirst
- getLast
- includes
- isArray
- isArrayLike
- isTypedArray
- sort
- sortBy
- times
- timesIter
- uniq
- uniqBy
Functions
castArray
▸ castArray<T
>(input
): T
[]
A simplified implementation of lodash castArray
Type parameters
Name |
---|
T |
Parameters
Name | Type | ||||
---|---|---|---|---|---|
input | undefined \ | null \ | T \ | T [] \ | readonly T [] |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:21
chunk
▸ chunk<T
>(dataArray
, size
): T
[][]
Chunk an array into specific sizes
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
dataArray | Iterable <T > |
size | number |
Returns
T
[][]
Defined in
packages/utils/src/arrays.ts:129
chunkIter
▸ chunkIter<T
>(dataArray
, size
): Iterable
<T
[]>
Chunk an array into specific size, by using an iterator
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
dataArray | Iterable <T > |
size | number |
Returns
Iterable
<T
[]>
Defined in
packages/utils/src/arrays.ts:134
concat
▸ concat<T
>(arr
, arr1?
): readonly T
[]
Concat and unique the items in the array Any non-array value will be converted to an array
Type parameters
Name |
---|
T |
Parameters
Name | Type | |
---|---|---|
arr | T \ | T [] |
arr1? | T \ | T [] |
Returns
readonly T
[]
Defined in
packages/utils/src/arrays.ts:32
▸ concat<T
>(arr
, arr1?
): readonly T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
arr | readonly T [] |
arr1? | readonly T [] |
Returns
readonly T
[]
Defined in
packages/utils/src/arrays.ts:33
▸ concat<T
>(arr
, arr1?
): readonly T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type | |
---|---|---|
arr | readonly T [] | |
arr1? | T \ | T [] |
Returns
readonly T
[]
Defined in
packages/utils/src/arrays.ts:34
flatten
▸ flatten<T
>(val
): T
[]
A native implementation of lodash flatten
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
val | Many <T []> |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:7
flattenDeep
▸ flattenDeep<T
>(val
): T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
val | ListOfRecursiveArraysOrValues <T > |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:11
getFirst
▸ getFirst<T
>(input
): T
| undefined
If the input is an array it will return the first item else if it will return the input
Type parameters
Name |
---|
T |
Parameters
Name | Type | ||
---|---|---|---|
input | T \ | T [] \ | readonly T [] |
Returns
T
| undefined
Defined in
packages/utils/src/arrays.ts:186
getLast
▸ getLast<T
>(input
): T
| undefined
If the input is an array it will return the first item else if it will return the input
Type parameters
Name |
---|
T |
Parameters
Name | Type | ||
---|---|---|---|
input | T \ | T [] \ | readonly T [] |
Returns
T
| undefined
Defined in
packages/utils/src/arrays.ts:194
includes
▸ includes(input
, key
): boolean
Safely check if an array, object, map, set has a key
Parameters
Name | Type |
---|---|
input | unknown |
key | string |
Returns
boolean
Defined in
packages/utils/src/arrays.ts:171
isArray
▸ isArray<T
>(input
): input is T
Check if an input is an array, just Array.isArray
Type parameters
Name | Type |
---|---|
T | any [] |
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is T
Defined in
packages/utils/src/arrays.ts:201
isArrayLike
▸ isArrayLike<T
>(input
): input is T
Check if an input is an TypedArray or Array instance
Type parameters
Name | Type |
---|---|
T | any [] |
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is T
Defined in
packages/utils/src/arrays.ts:216
isTypedArray
▸ isTypedArray<T
>(input
): input is T
Check if an input is an TypedArray instance like: Uint8Array or Uint16Array. This excludes nodejs Buffers since they aren't really the same.
Type parameters
Name | Type |
---|---|
T | TypedArray |
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is T
Defined in
packages/utils/src/arrays.ts:209
sort
▸ sort<T
>(arr
, compare?
): T
[]
Sort an arr or set
Type parameters
Name |
---|
T |
Parameters
Name | Type | ||
---|---|---|---|
arr | Set <T > \ | T [] \ | readonly T [] |
compare? | (a : T , b : T ) => number |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:49
sortBy
▸ sortBy<T
, V
>(arr
, fnOrPath
): T
[]
Sort by path or function that returns the values to sort with
Type parameters
Name | Type |
---|---|
T | T |
V | any |
Parameters
Name | Type | |
---|---|---|
arr | Set <T > \ | T [] |
fnOrPath | string \ | (value : T ) => V |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:64
times
▸ times(n
): number
[]
A native implementation of lodash times
Parameters
Name | Type |
---|---|
n | number |
Returns
number
[]
Defined in
packages/utils/src/arrays.ts:111
▸ times<T
>(n
, fn
): T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
n | number |
fn | (index : number ) => T |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:112
timesIter
▸ timesIter(n
): Iterable
<number
>
Like times but an iterable
Parameters
Name | Type |
---|---|
n | number |
Returns
Iterable
<number
>
Defined in
packages/utils/src/arrays.ts:119
▸ timesIter<T
>(n
, fn
): Iterable
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
n | number |
fn | (index : number ) => T |
Returns
Iterable
<T
>
Defined in
packages/utils/src/arrays.ts:120
uniq
▸ uniq<T
>(arr
): T
[]
A native implementation of lodash uniq
Type parameters
Name |
---|
T |
Parameters
Name | Type | |
---|---|---|
arr | T [] \ | Set <T > |
Returns
T
[]
Defined in
packages/utils/src/arrays.ts:43
uniqBy
▸ uniqBy<T
, V
>(values
, fnOrPath
): T
[]
Get the unique values by a path or function that returns the unique values
Type parameters
Name | Type |
---|---|
T | T |
V | any |
Parameters
Name | Type | |
---|---|---|
values | T [] \ | readonly T [] |
fnOrPath | string \ | (value : T ) => V |
Returns
T
[]