@terascope/utils / arrays

arrays

Functions

castArray()

castArray<T>(input): T[]

Defined in: packages/utils/src/arrays.ts:22

A simplified implementation of lodash castArray

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
input	undefined | null | T | T[] | readonly T[]

Returns

T[]

---

chunk()

chunk<T>(dataArray, size): T[][]

Defined in: packages/utils/src/arrays.ts:130

Chunk an array into specific sizes

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
dataArray	Iterable<T>
size	number

Returns

T[][]

---

chunkIter()

chunkIter<T>(dataArray, size): Iterable<T[]>

Defined in: packages/utils/src/arrays.ts:135

Chunk an array into specific size, by using an iterator

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
dataArray	Iterable<T>
size	number

Returns

Iterable<T[]>

---

concat()

Call Signature

concat<T>(arr, arr1?): readonly T[]

Defined in: packages/utils/src/arrays.ts:33

Concat and unique the items in the array Any non-array value will be converted to an array

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
arr	T | T[]
arr1?	T | T[]

Returns

readonly T[]

Call Signature

concat<T>(arr, arr1?): readonly T[]

Defined in: packages/utils/src/arrays.ts:34

Concat and unique the items in the array Any non-array value will be converted to an array

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
arr	readonly T[]
arr1?	readonly T[]

Returns

readonly T[]

Call Signature

concat<T>(arr, arr1?): readonly T[]

Defined in: packages/utils/src/arrays.ts:35

Concat and unique the items in the array Any non-array value will be converted to an array

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
arr	readonly T[]
arr1?	T | T[]

Returns

readonly T[]

---

flatten()

flatten<T>(val): T[]

Defined in: packages/utils/src/arrays.ts:8

A native implementation of lodash flatten

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
val	Many<T[]>

Returns

T[]

---

flattenDeep()

flattenDeep<T>(val): T[]

Defined in: packages/utils/src/arrays.ts:12

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
val	ListOfRecursiveArraysOrValues<T>

Returns

T[]

---

getFirst()

getFirst<T>(input): undefined | T

Defined in: packages/utils/src/arrays.ts:187

If the input is an array it will return the first item else if it will return the input

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
input	T | T[] | readonly T[]

Returns

undefined | T

---

getLast()

getLast<T>(input): undefined | T

Defined in: packages/utils/src/arrays.ts:195

If the input is an array it will return the first item else if it will return the input

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
input	T | T[] | readonly T[]

Returns

undefined | T

---

includes()

includes(input, key): boolean

Defined in: packages/utils/src/arrays.ts:172

Safely check if an array, object, map, set has a key

Parameters

Parameter	Type
input	unknown
key	string

Returns

boolean

---

isArray()

isArray<T>(input): input is T

Defined in: packages/utils/src/arrays.ts:202

Check if an input is an array, just Array.isArray

Type Parameters

Type Parameter	Default type
T	any[]

Parameters

Parameter	Type
input	unknown

Returns

input is T

---

isArrayLike()

isArrayLike<T>(input): input is T

Defined in: packages/utils/src/arrays.ts:217

Check if an input is an TypedArray or Array instance

Type Parameters

Type Parameter	Default type
T	any[]

Parameters

Parameter	Type
input	unknown

Returns

input is T

---

isTypedArray()

isTypedArray<T>(input): input is T

Defined in: packages/utils/src/arrays.ts:210

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

Type Parameter	Default type
T	TypedArray

Parameters

Parameter	Type
input	unknown

Returns

input is T

---

sort()

sort<T>(arr, compare?): T[]

Defined in: packages/utils/src/arrays.ts:50

Sort an arr or set

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
arr	Set<T> | T[] | readonly T[]
compare?	(a, b) => number

Returns

T[]

---

sortBy()

sortBy<T, V>(arr, fnOrPath): T[]

Defined in: packages/utils/src/arrays.ts:65

Sort by path or function that returns the values to sort with

Type Parameters

Type Parameter	Default type
T	-
V	any

Parameters

Parameter	Type
arr	Set<T> | T[]
fnOrPath	string | (value) => V

Returns

T[]

---

times()

Call Signature

times(n): number[]

Defined in: packages/utils/src/arrays.ts:112

A native implementation of lodash times

Parameters

Parameter	Type
n	number

Returns

number[]

Call Signature

times<T>(n, fn): T[]

Defined in: packages/utils/src/arrays.ts:113

A native implementation of lodash times

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
n	number
fn	(index) => T

Returns

T[]

---

timesIter()

Call Signature

timesIter(n): Iterable<number>

Defined in: packages/utils/src/arrays.ts:120

Like times but an iterable

Parameters

Parameter	Type
n	number

Returns

Iterable<number>

Call Signature

timesIter<T>(n, fn): Iterable<T>

Defined in: packages/utils/src/arrays.ts:121

Like times but an iterable

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
n	number
fn	(index) => T

Returns

Iterable<T>

---

uniq()

uniq<T>(arr): T[]

Defined in: packages/utils/src/arrays.ts:44

A native implementation of lodash uniq

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
arr	T[] | Set<T>

Returns

T[]

---

uniqBy()

uniqBy<T, V>(values, fnOrPath): T[]

Defined in: packages/utils/src/arrays.ts:95

Get the unique values by a path or function that returns the unique values

Type Parameters

Type Parameter	Default type
T	-
V	any

Parameters

Parameter	Type
values	T[] | readonly T[]
fnOrPath	string | (value) => V

Returns

T[]